{
    "openapi": "3.2.0",
    "info": {
        "title": "Monica API",
        "description": "Everything this product does in its own screens can be done here. Records are answered as a type, an id, an attributes object and a link to themselves, timestamps are a count of seconds since 1970, and anything belonging to another account answers 404 rather than saying it exists.",
        "version": "v1",
        "license": {
            "name": "AGPL-3.0-or-later",
            "identifier": "AGPL-3.0-or-later"
        },
        "contact": {
            "name": "Monica",
            "url": "https://my.monicahq.com/docs/api"
        }
    },
    "servers": [
        {
            "url": "https://my.monicahq.com/api/v1",
            "description": "This instance."
        }
    ],
    "tags": [
        {
            "name": "Authentication",
            "description": "Open a session, close one, and register an account. These are the only endpoints that need no token."
        },
        {
            "name": "Your profile",
            "description": "The person behind the account: their name, the language they read in and the zone their days are counted in."
        },
        {
            "name": "API keys",
            "description": "The tokens that reach this API. Create one, look at what you hold, and revoke what you no longer use."
        },
        {
            "name": "Vaults",
            "description": "The compartments an account is divided into. A record belongs to exactly one, and moving it between them is deliberate."
        },
        {
            "name": "Contacts",
            "description": "The people a vault holds, their names, their pictures and the template version each one is read through."
        },
        {
            "name": "Kinds of record",
            "description": "The sorts of thing a vault keeps besides people, each with its own template and its own place in the order."
        },
        {
            "name": "Logs",
            "description": "What happened on the account, who did it and from which interface, appended and never rewritten."
        },
        {
            "name": "Emails sent",
            "description": "Every message the product sent on the account behalf, with what became of it."
        },
        {
            "name": "Health",
            "description": "Whether the instance is answering, and whether what it depends on is answering it."
        },
        {
            "name": "Templates",
            "description": "How a record is laid out: its versions, its pages, the sections on them and the fields in those. A published version is frozen."
        },
        {
            "name": "Billing",
            "description": "What the account pays, what it has paid, and the way to change or stop paying."
        },
        {
            "name": "Duplicates and merges",
            "description": "Contacts that look like the same person, and the act of folding one into another without losing what either held."
        },
        {
            "name": "Notifications",
            "description": "What the product has told the account holder, and whether they have read it."
        },
        {
            "name": "Notification channels",
            "description": "Where a notification is delivered, proving a destination belongs to whoever named it."
        },
        {
            "name": "Relationship categories",
            "description": "The categories relationship types are filed under, which order the vocabulary rather than deciding anything."
        },
        {
            "name": "Relationship types",
            "description": "The kinds of tie one contact can have to another, each with the wording read from either side."
        },
        {
            "name": "Life event categories",
            "description": "The categories life event natures are filed under, which order the vocabulary and give statistics a level to count at."
        },
        {
            "name": "Life event types",
            "description": "The natures a life event may be recorded as, and the custom fields each one asks for."
        },
        {
            "name": "Reminders",
            "description": "The reminders about a contact, the reminders and the dates of a whole vault, and what you answered for each date."
        },
        {
            "name": "Search",
            "description": "Find the people, entities and life events that hold the words you type, anywhere in what is written on them."
        },
        {
            "name": "Life events",
            "description": "What happened, on a date, with people: a call, a meal, a move, a wedding. Recording one puts it on the timeline of everybody who was there."
        },
        {
            "name": "Relationships",
            "description": "How the people of a vault are linked to each other. One relationship holds both sides, so it reads the same from either person."
        },
        {
            "name": "MCP history",
            "description": "Every call an assistant made to a tool of the MCP server on your account, including reads, refusals and failures, kept apart from the account log."
        },
        {
            "name": "Imports",
            "description": "Bring an export of Monica 4, or an export of this application, into the account. The file is read first, and nothing is written until you have seen what it holds and chosen where it goes."
        },
        {
            "name": "Locations",
            "description": "The places the things of your account are kept in, each of them inside another as deep as you like."
        },
        {
            "name": "Exports",
            "description": "Take the data of the account out, as one JSON file another instance of this application can import. The file is prepared in the background and kept for seven days, or until a newer export of the account is ready, then deleted."
        },
        {
            "name": "Possession types",
            "description": "The kinds of things your account owns, and the fields a thing of each kind carries."
        },
        {
            "name": "Possessions",
            "description": "The things kept in a vault: what they are, where they are, and what the fields of their type say about them."
        },
        {
            "name": "Possession tags",
            "description": "The words your account puts on its possessions, to sort them across types and locations."
        },
        {
            "name": "Possession conditions",
            "description": "The states the possessions of your account can be in, from best to worst."
        },
        {
            "name": "Possession transactions",
            "description": "Money and ownership changing hands for a possession. Its acquisition date, its acquisition price and what it cost since are read from here."
        },
        {
            "name": "Possession insurance records",
            "description": "How a possession is insured, one record per policy period. When a policy renews with a new insured value, or the insurer changes, a new record is added, and the earlier ones stay as the history of the coverage."
        },
        {
            "name": "Possession maintenance records",
            "description": "The work done on a possession over time, one record per job: an inspection, a cleaning, a repair, a restoration. Each record may say what condition the possession was in before and after the job, and when the job should be done again."
        },
        {
            "name": "Support requests",
            "description": "Ask the support team a question and follow the conversation. A request holds a thread of messages between you and the team, and moves between three statuses: to_handle while the team has yet to answer, waiting_on_user once it has, and solved. Writing to a request always puts it back in to_handle."
        },
        {
            "name": "Knowledge folders",
            "description": "The folders of a vault's Knowledge, which group its notes and lists by theme: Home, Travel, Health. Folders are flat, never nested, and a vault that holds Knowledge keeps at least one."
        },
        {
            "name": "Support administration",
            "description": "Work through the support queue of the whole instance: read the requests of every account, answer them, leave notes for the team and move them between statuses. Only an administrator of this instance can use these endpoints, and only with an API key that carries the administration scope by name. Anybody else, including an administrator whose key does not carry it, gets 404 as though the endpoint did not exist."
        },
        {
            "name": "Knowledge notes",
            "description": "Free text kept in a folder of a vault's Knowledge, written in Markdown. A note links to no contact, possession or other note."
        },
        {
            "name": "Knowledge lists",
            "description": "Tables kept in a folder of a vault's Knowledge: the books somebody has read, the paint reference of each room. The owner names the columns, every column holds text, and each item holds one text per column."
        },
        {
            "name": "Possession valuations",
            "description": "Estimates of what a possession is worth, each on one date. A valuation is never changed once recorded: a correction is a new valuation, so the earlier ones stay as the history of how the value moved. The latest by date is the current value of the possession."
        },
        {
            "name": "Possession provenance",
            "description": "The moments in the history of a possession: where it was made, who owned or held it, when it was lost or recovered, and what authenticated, exhibited or published it. An event holds no money: a moment that cost something points at the transaction that records it."
        },
        {
            "name": "Possession locations",
            "description": "Where a possession has been kept since it was recorded. Each stay is one location of the account and the days the possession spent there. The open stay, with no day it left, is where the possession is now, and it is always the location the possession reports."
        },
        {
            "name": "Possession loans",
            "description": "Who has a possession and when it is due back. A loan is one period the possession is lent to a contact of its vault, or borrowed from one, without any change of owner, so it records no transaction. A possession has at most one active loan."
        },
        {
            "name": "Possession timeline",
            "description": "Everything that happened to a possession, read from its sections and stored nowhere: the transactions, insurance records, valuations, provenance events, maintenance records, loans and stays, in one list. To change an entry, change the record it is read from."
        },
        {
            "name": "What’s new",
            "description": "The changes made to the product, as the What’s new screen shows them. A change is the same for every account, so there is nothing to create, change or delete. You can mark the changes as seen, vote on one, and comment on it. Titles, areas and explanations come back in the language of the person the key belongs to."
        },
        {
            "name": "Agent feedback",
            "description": "An AI agent connected through MCP tells the administrators of this instance that a tool failed, was missing or misled it, with what it tried and the fix it suggests. Administrators read the reports, leave notes and move them between statuses. The agent is asked to paraphrase the request and to leave names, dates and other details from the vault out."
        }
    ],
    "security": [
        {
            "bearerAuth": []
        }
    ],
    "paths": {
        "/register": {
            "post": {
                "operationId": "register-store",
                "tags": [
                    "Authentication"
                ],
                "summary": "Register",
                "description": "Open an account from outside the browser, and get a token for it.\n\nThe account this builds is the account the sign up screen builds, down to the first vault and the lists it starts with. The terms are asked for here too, because a second way in that skipped them would be a way around them.\n\nAn instance can stop accepting new accounts. While it does, this endpoint answers 404 whatever the body holds, before anything is validated, exactly as the sign up screen does.\n\nThe one exception is somebody an administrator admitted from the waiting list. Their email holds a link ending in a token, and sending that token as admission opens the account while new accounts are refused. The account then takes the admitted address whatever email holds, that address is already verified, and the token stops working. A token that is unknown, used, replaced or expired is ignored while the instance accepts new accounts, and answers 404 while it does not.\n\nRate limit: Six requests per minute, per address.",
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "first_name": {
                                        "type": "string",
                                        "description": "The first name of the person opening the account. Maximum 255 characters."
                                    },
                                    "last_name": {
                                        "type": "string",
                                        "description": "The last name of the person opening the account. Maximum 255 characters."
                                    },
                                    "email": {
                                        "type": "string",
                                        "description": "The address to sign in with, stored in lowercase. Held by nobody else, and not from a throwaway provider."
                                    },
                                    "password": {
                                        "type": "string",
                                        "description": "At least 8 characters. Only a hash of it is ever written down."
                                    },
                                    "password_confirmation": {
                                        "type": "string",
                                        "description": "The password again, exactly as above."
                                    },
                                    "admission": {
                                        "type": "string",
                                        "description": "The token at the end of the link an administrator sent from the waiting list, 64 characters. Only needed while the instance refuses new accounts."
                                    },
                                    "terms": {
                                        "type": "boolean",
                                        "description": "Agreement with the terms of use and the privacy policy. An account cannot be opened without it."
                                    },
                                    "timezone": {
                                        "type": "string",
                                        "description": "An IANA time zone, which every date is then rendered in. Defaults to UTC."
                                    },
                                    "device_name": {
                                        "type": "string",
                                        "description": "What the token is for, in a few words. It names the key in security settings, so each integration can be revoked on its own."
                                    }
                                },
                                "required": [
                                    "first_name",
                                    "last_name",
                                    "email",
                                    "password",
                                    "password_confirmation",
                                    "terms"
                                ]
                            },
                            "example": {
                                "first_name": "Michael",
                                "last_name": "Scott",
                                "email": "michael.scott@dundermifflin.com",
                                "password": "a-very-strong-password",
                                "password_confirmation": "a-very-strong-password",
                                "admission": "aaaabbbbccccddddeeeeffffgggghhhhiiiijjjjkkkkllllmmmmnnnnoooopppp",
                                "terms": true,
                                "device_name": "Dundie awards bot"
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "A token, in plain text. This is the only time it exists in that form: only a hash of it is kept, so a token you fail to copy has to be made again.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "token": {
                                            "type": [
                                                "string",
                                                "null"
                                            ],
                                            "description": "The bearer token. Send it as an Authorization header reading Bearer followed by this value, on every other endpoint. This is the only time it exists in readable form: only a hash of it is kept, so a token you fail to copy has to be made again."
                                        },
                                        "expires_at": {
                                            "type": [
                                                "integer",
                                                "null"
                                            ],
                                            "description": "When the token stops working, as a count of seconds, or null when it never does. Every token issued today is null: expiry is not something this API sets yet, and a token is ended by revoking it."
                                        }
                                    }
                                },
                                "example": {
                                    "token": "1|f9aB2cD3eF4gH5iJ6kL7mN8oP9qR0sT1uV2w",
                                    "expires_at": null
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                },
                "security": []
            }
        },
        "/login": {
            "post": {
                "operationId": "login-store",
                "tags": [
                    "Authentication"
                ],
                "summary": "Log in",
                "description": "Exchange an address and a password for a token. The token is named after device_name, so you can tell your integrations apart later and revoke one without touching the rest.\n\nA user who has turned on two factor authentication must send a valid code as well, from their authenticator app or from their recovery codes. No token is issued until it passes, because an endpoint that skipped it would be a way around the second factor rather than another way in.\n\nWrong password, suspended account, an account that signs in through an external provider, and an address nobody holds all answer the same way. Anything else would tell somebody which addresses have accounts here.\n\nRate limit: Six requests per minute, per address.",
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "email": {
                                        "type": "string",
                                        "description": "The address the account signs in with."
                                    },
                                    "password": {
                                        "type": "string",
                                        "description": "The password of the account."
                                    },
                                    "code": {
                                        "type": "string",
                                        "description": "A code from the authenticator app, or one of the recovery codes. Required when the user has two factor authentication turned on. A recovery code is spent the moment it works."
                                    },
                                    "device_name": {
                                        "type": "string",
                                        "description": "What the token is for, in a few words. Shown in security settings."
                                    }
                                },
                                "required": [
                                    "email",
                                    "password"
                                ]
                            },
                            "example": {
                                "email": "michael.scott@dundermifflin.com",
                                "password": "a-very-strong-password",
                                "device_name": "Dundie awards bot"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "A token, in plain text, or a 401 status when anything at all was wrong with the credentials.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "token": {
                                            "type": [
                                                "string",
                                                "null"
                                            ],
                                            "description": "The bearer token. Send it as an Authorization header reading Bearer followed by this value, on every other endpoint. This is the only time it exists in readable form: only a hash of it is kept, so a token you fail to copy has to be made again."
                                        },
                                        "expires_at": {
                                            "type": [
                                                "integer",
                                                "null"
                                            ],
                                            "description": "When the token stops working, as a count of seconds, or null when it never does. Every token issued today is null: expiry is not something this API sets yet, and a token is ended by revoking it."
                                        }
                                    }
                                },
                                "example": {
                                    "token": "1|f9aB2cD3eF4gH5iJ6kL7mN8oP9qR0sT1uV2w",
                                    "expires_at": null
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                },
                "security": []
            }
        },
        "/logout": {
            "delete": {
                "operationId": "logout-destroy",
                "tags": [
                    "Authentication"
                ],
                "summary": "Log out",
                "description": "Revokes the token you are calling with. Anything still using it stops working, immediately.\n\nYour other tokens are untouched, which is the point of naming them: an integration you no longer trust can be cut off without signing everything else out.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "responses": {
                    "204": {
                        "description": "Nothing at all."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/me": {
            "get": {
                "operationId": "me-show",
                "tags": [
                    "Your profile"
                ],
                "summary": "Get your profile",
                "description": "Retrieve the user the token belongs to. A token acts as one person, so there is nobody else to ask for here and no id in the URL.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "responses": {
                    "200": {
                        "description": "A user object. Credentials never appear in it: not the password, not the second factor, not the recovery codes.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The person the token acts as.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always user. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "first_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The given name, up to 255 characters. Which of the two names is shown first is name_order rather than this."
                                                        },
                                                        "last_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The family name, up to 255 characters."
                                                        },
                                                        "email": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The address the account signs in with, up to 255 characters, always in lower case. It is unique across the instance."
                                                        },
                                                        "email_verified": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the address has been confirmed. Worked out from when it was confirmed rather than stored as a flag, so the moment itself is not something the API hands out."
                                                        },
                                                        "locale": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The language the product speaks to this person: one of bn_BD, ca_ES, da_DK, de_DE, el_GR, en, es_ES, fi_FI, fil_PH, fr_FR, ga_IE, hi_IN, hu_HU, is_IS, it_IT, ja_JP, ko_KR, lt_LT, nb_NO, nl_NL, pl_PL, pt_BR, pt_PT, ru_RU, si_LK, sv_SE, ta_IN, th_TH, tr_TR, uz_UZ, vi_VN or zh_CN. It never affects anything the person themselves wrote."
                                                        },
                                                        "timezone": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The zone their times are shown in, as an identifier such as Europe/Paris, up to 64 characters. Every timestamp in this API is a count of seconds regardless, so this is about what a screen shows rather than about what you receive."
                                                        },
                                                        "time_format": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either 24 or 12, saying which clock they read."
                                                        },
                                                        "date_format": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How a date is written for them: one of d/m/Y, m/d/Y, Y-m-d or j F Y, or null when they have not chosen and the language decides."
                                                        },
                                                        "name_order": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either given_first or family_first. Which name comes first varies by culture, so it is a setting rather than an assumption."
                                                        },
                                                        "number_format": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How a number is grouped and pointed: one of comma_dot, dot_comma, space_comma or no_separator, or null when they have not chosen and the language decides."
                                                        },
                                                        "contact_list_grouping": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Which people the contact list was last showing them: one of all, favourites or names-only, or null until they have opened the list."
                                                        },
                                                        "contact_list_sort": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the contact list was last ordered by: one of name, nickname, last-spoke or added, or null until they have opened the list."
                                                        },
                                                        "contact_list_direction": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Which way round that order ran: asc or desc, or null until they have opened the list."
                                                        },
                                                        "shows_vault_list": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the person lands on the list of their vaults, or goes straight to their default vault. True until they turn it off. While it is false, their default vault cannot be deleted."
                                                        },
                                                        "welcomed_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the user dismissed the welcome screen, as a count of seconds, or null if they have not."
                                                        },
                                                        "full_access_offer_dismissed_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the user hid the banner offering full access, as a count of seconds, or null if they have not."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the account was opened, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the profile last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "user",
                                        "id": "1",
                                        "attributes": {
                                            "first_name": "Michael",
                                            "last_name": "Scott",
                                            "email": "michael.scott@dundermifflin.com",
                                            "email_verified": true,
                                            "locale": "en",
                                            "timezone": "America/New_York",
                                            "time_format": "24",
                                            "date_format": null,
                                            "name_order": "given_first",
                                            "number_format": null,
                                            "contact_list_grouping": "favourites",
                                            "contact_list_sort": "last-spoke",
                                            "contact_list_direction": "desc",
                                            "shows_vault_list": true,
                                            "welcomed_at": 1756252860,
                                            "full_access_offer_dismissed_at": null,
                                            "created_at": 1756252800,
                                            "updated_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/me"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "me-show-query",
                "tags": [
                    "Your profile"
                ],
                "summary": "Get your profile",
                "description": "Retrieve the user the token belongs to. A token acts as one person, so there is nobody else to ask for here and no id in the URL.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "responses": {
                    "200": {
                        "description": "A user object. Credentials never appear in it: not the password, not the second factor, not the recovery codes.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The person the token acts as.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always user. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "first_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The given name, up to 255 characters. Which of the two names is shown first is name_order rather than this."
                                                        },
                                                        "last_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The family name, up to 255 characters."
                                                        },
                                                        "email": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The address the account signs in with, up to 255 characters, always in lower case. It is unique across the instance."
                                                        },
                                                        "email_verified": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the address has been confirmed. Worked out from when it was confirmed rather than stored as a flag, so the moment itself is not something the API hands out."
                                                        },
                                                        "locale": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The language the product speaks to this person: one of bn_BD, ca_ES, da_DK, de_DE, el_GR, en, es_ES, fi_FI, fil_PH, fr_FR, ga_IE, hi_IN, hu_HU, is_IS, it_IT, ja_JP, ko_KR, lt_LT, nb_NO, nl_NL, pl_PL, pt_BR, pt_PT, ru_RU, si_LK, sv_SE, ta_IN, th_TH, tr_TR, uz_UZ, vi_VN or zh_CN. It never affects anything the person themselves wrote."
                                                        },
                                                        "timezone": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The zone their times are shown in, as an identifier such as Europe/Paris, up to 64 characters. Every timestamp in this API is a count of seconds regardless, so this is about what a screen shows rather than about what you receive."
                                                        },
                                                        "time_format": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either 24 or 12, saying which clock they read."
                                                        },
                                                        "date_format": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How a date is written for them: one of d/m/Y, m/d/Y, Y-m-d or j F Y, or null when they have not chosen and the language decides."
                                                        },
                                                        "name_order": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either given_first or family_first. Which name comes first varies by culture, so it is a setting rather than an assumption."
                                                        },
                                                        "number_format": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How a number is grouped and pointed: one of comma_dot, dot_comma, space_comma or no_separator, or null when they have not chosen and the language decides."
                                                        },
                                                        "contact_list_grouping": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Which people the contact list was last showing them: one of all, favourites or names-only, or null until they have opened the list."
                                                        },
                                                        "contact_list_sort": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the contact list was last ordered by: one of name, nickname, last-spoke or added, or null until they have opened the list."
                                                        },
                                                        "contact_list_direction": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Which way round that order ran: asc or desc, or null until they have opened the list."
                                                        },
                                                        "shows_vault_list": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the person lands on the list of their vaults, or goes straight to their default vault. True until they turn it off. While it is false, their default vault cannot be deleted."
                                                        },
                                                        "welcomed_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the user dismissed the welcome screen, as a count of seconds, or null if they have not."
                                                        },
                                                        "full_access_offer_dismissed_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the user hid the banner offering full access, as a count of seconds, or null if they have not."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the account was opened, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the profile last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "user",
                                        "id": "1",
                                        "attributes": {
                                            "first_name": "Michael",
                                            "last_name": "Scott",
                                            "email": "michael.scott@dundermifflin.com",
                                            "email_verified": true,
                                            "locale": "en",
                                            "timezone": "America/New_York",
                                            "time_format": "24",
                                            "date_format": null,
                                            "name_order": "given_first",
                                            "number_format": null,
                                            "contact_list_grouping": "favourites",
                                            "contact_list_sort": "last-spoke",
                                            "contact_list_direction": "desc",
                                            "shows_vault_list": true,
                                            "welcomed_at": 1756252860,
                                            "full_access_offer_dismissed_at": null,
                                            "created_at": 1756252800,
                                            "updated_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/me"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "put": {
                "operationId": "me-update",
                "tags": [
                    "Your profile"
                ],
                "summary": "Update your profile",
                "description": "Update the name of the user the token belongs to.\n\nThe address the user signs in with is not changed here. Changing it asks for the password again, which only the security settings can do, so an `email` sent here is ignored. Preferences such as the locale, the time zone and the clock are not changed here either.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "first_name": {
                                        "type": "string",
                                        "description": "The first name of the user. Maximum 255 characters. It cannot be null."
                                    },
                                    "last_name": {
                                        "type": "string",
                                        "description": "The last name of the user. Maximum 255 characters. It cannot be null."
                                    }
                                }
                            },
                            "example": {
                                "first_name": "Michael",
                                "last_name": "Scott"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The updated user object.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The person the token acts as.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always user. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "first_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The given name, up to 255 characters. Which of the two names is shown first is name_order rather than this."
                                                        },
                                                        "last_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The family name, up to 255 characters."
                                                        },
                                                        "email": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The address the account signs in with, up to 255 characters, always in lower case. It is unique across the instance."
                                                        },
                                                        "email_verified": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the address has been confirmed. Worked out from when it was confirmed rather than stored as a flag, so the moment itself is not something the API hands out."
                                                        },
                                                        "locale": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The language the product speaks to this person: one of bn_BD, ca_ES, da_DK, de_DE, el_GR, en, es_ES, fi_FI, fil_PH, fr_FR, ga_IE, hi_IN, hu_HU, is_IS, it_IT, ja_JP, ko_KR, lt_LT, nb_NO, nl_NL, pl_PL, pt_BR, pt_PT, ru_RU, si_LK, sv_SE, ta_IN, th_TH, tr_TR, uz_UZ, vi_VN or zh_CN. It never affects anything the person themselves wrote."
                                                        },
                                                        "timezone": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The zone their times are shown in, as an identifier such as Europe/Paris, up to 64 characters. Every timestamp in this API is a count of seconds regardless, so this is about what a screen shows rather than about what you receive."
                                                        },
                                                        "time_format": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either 24 or 12, saying which clock they read."
                                                        },
                                                        "date_format": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How a date is written for them: one of d/m/Y, m/d/Y, Y-m-d or j F Y, or null when they have not chosen and the language decides."
                                                        },
                                                        "name_order": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either given_first or family_first. Which name comes first varies by culture, so it is a setting rather than an assumption."
                                                        },
                                                        "number_format": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How a number is grouped and pointed: one of comma_dot, dot_comma, space_comma or no_separator, or null when they have not chosen and the language decides."
                                                        },
                                                        "contact_list_grouping": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Which people the contact list was last showing them: one of all, favourites or names-only, or null until they have opened the list."
                                                        },
                                                        "contact_list_sort": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the contact list was last ordered by: one of name, nickname, last-spoke or added, or null until they have opened the list."
                                                        },
                                                        "contact_list_direction": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Which way round that order ran: asc or desc, or null until they have opened the list."
                                                        },
                                                        "shows_vault_list": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the person lands on the list of their vaults, or goes straight to their default vault. True until they turn it off. While it is false, their default vault cannot be deleted."
                                                        },
                                                        "welcomed_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the user dismissed the welcome screen, as a count of seconds, or null if they have not."
                                                        },
                                                        "full_access_offer_dismissed_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the user hid the banner offering full access, as a count of seconds, or null if they have not."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the account was opened, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the profile last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "user",
                                        "id": "1",
                                        "attributes": {
                                            "first_name": "Michael",
                                            "last_name": "Scott",
                                            "email": "michael.scott@dundermifflin.com",
                                            "email_verified": true,
                                            "locale": "en",
                                            "timezone": "America/New_York",
                                            "time_format": "24",
                                            "date_format": null,
                                            "name_order": "given_first",
                                            "number_format": null,
                                            "contact_list_grouping": "favourites",
                                            "contact_list_sort": "last-spoke",
                                            "contact_list_direction": "desc",
                                            "shows_vault_list": true,
                                            "welcomed_at": 1756252860,
                                            "full_access_offer_dismissed_at": null,
                                            "created_at": 1756252800,
                                            "updated_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/me"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/me/contact-list-view": {
            "put": {
                "operationId": "me-contact-list-view-update",
                "tags": [
                    "Your profile"
                ],
                "summary": "Set your contact list view",
                "description": "Set the view the contact list opens on for the user the token belongs to.\n\nThe three choices make one view. A choice left out keeps the one stored, so sending a grouping alone changes the grouping and keeps the order. None of the three can be null.\n\nIt applies to every vault the user reaches, and it changes what the interface opens on rather than what this API answers: reading a contact list here takes its own filter, sort and direction, and neither reads nor writes this.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "grouping": {
                                        "type": "string",
                                        "description": "Which people the list shows: all, favourites or names-only."
                                    },
                                    "sort": {
                                        "type": "string",
                                        "description": "What the list is ordered by: name, nickname, last-spoke or added."
                                    },
                                    "direction": {
                                        "type": "string",
                                        "description": "Which way round that order runs: asc or desc."
                                    }
                                }
                            },
                            "example": {
                                "grouping": "favourites",
                                "sort": "last-spoke",
                                "direction": "desc"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The updated user object.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The person the token acts as.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always user. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "first_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The given name, up to 255 characters. Which of the two names is shown first is name_order rather than this."
                                                        },
                                                        "last_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The family name, up to 255 characters."
                                                        },
                                                        "email": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The address the account signs in with, up to 255 characters, always in lower case. It is unique across the instance."
                                                        },
                                                        "email_verified": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the address has been confirmed. Worked out from when it was confirmed rather than stored as a flag, so the moment itself is not something the API hands out."
                                                        },
                                                        "locale": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The language the product speaks to this person: one of bn_BD, ca_ES, da_DK, de_DE, el_GR, en, es_ES, fi_FI, fil_PH, fr_FR, ga_IE, hi_IN, hu_HU, is_IS, it_IT, ja_JP, ko_KR, lt_LT, nb_NO, nl_NL, pl_PL, pt_BR, pt_PT, ru_RU, si_LK, sv_SE, ta_IN, th_TH, tr_TR, uz_UZ, vi_VN or zh_CN. It never affects anything the person themselves wrote."
                                                        },
                                                        "timezone": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The zone their times are shown in, as an identifier such as Europe/Paris, up to 64 characters. Every timestamp in this API is a count of seconds regardless, so this is about what a screen shows rather than about what you receive."
                                                        },
                                                        "time_format": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either 24 or 12, saying which clock they read."
                                                        },
                                                        "date_format": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How a date is written for them: one of d/m/Y, m/d/Y, Y-m-d or j F Y, or null when they have not chosen and the language decides."
                                                        },
                                                        "name_order": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either given_first or family_first. Which name comes first varies by culture, so it is a setting rather than an assumption."
                                                        },
                                                        "number_format": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How a number is grouped and pointed: one of comma_dot, dot_comma, space_comma or no_separator, or null when they have not chosen and the language decides."
                                                        },
                                                        "contact_list_grouping": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Which people the contact list was last showing them: one of all, favourites or names-only, or null until they have opened the list."
                                                        },
                                                        "contact_list_sort": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the contact list was last ordered by: one of name, nickname, last-spoke or added, or null until they have opened the list."
                                                        },
                                                        "contact_list_direction": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Which way round that order ran: asc or desc, or null until they have opened the list."
                                                        },
                                                        "shows_vault_list": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the person lands on the list of their vaults, or goes straight to their default vault. True until they turn it off. While it is false, their default vault cannot be deleted."
                                                        },
                                                        "welcomed_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the user dismissed the welcome screen, as a count of seconds, or null if they have not."
                                                        },
                                                        "full_access_offer_dismissed_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the user hid the banner offering full access, as a count of seconds, or null if they have not."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the account was opened, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the profile last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "user",
                                        "id": "1",
                                        "attributes": {
                                            "first_name": "Michael",
                                            "last_name": "Scott",
                                            "email": "michael.scott@dundermifflin.com",
                                            "email_verified": true,
                                            "locale": "en",
                                            "timezone": "America/New_York",
                                            "time_format": "24",
                                            "date_format": null,
                                            "name_order": "given_first",
                                            "number_format": null,
                                            "contact_list_grouping": "favourites",
                                            "contact_list_sort": "last-spoke",
                                            "contact_list_direction": "desc",
                                            "shows_vault_list": true,
                                            "welcomed_at": 1756252860,
                                            "full_access_offer_dismissed_at": null,
                                            "created_at": 1756252800,
                                            "updated_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/me"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/me/welcome": {
            "put": {
                "operationId": "me-welcome-update",
                "tags": [
                    "Your profile"
                ],
                "summary": "Dismiss the welcome screen",
                "description": "Record that the user the token belongs to has read the welcome screen.\n\nA new account is sent to a welcome screen the first time it reaches the web application. An application that shows its own welcome calls this so the web one does not greet the same person twice.\n\nDismissing it twice keeps the first moment, because that is when it was read. The screen itself stays open to anybody who asks for it, so there is nothing to undo.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "responses": {
                    "200": {
                        "description": "The updated user object.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The person the token acts as.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always user. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "first_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The given name, up to 255 characters. Which of the two names is shown first is name_order rather than this."
                                                        },
                                                        "last_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The family name, up to 255 characters."
                                                        },
                                                        "email": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The address the account signs in with, up to 255 characters, always in lower case. It is unique across the instance."
                                                        },
                                                        "email_verified": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the address has been confirmed. Worked out from when it was confirmed rather than stored as a flag, so the moment itself is not something the API hands out."
                                                        },
                                                        "locale": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The language the product speaks to this person: one of bn_BD, ca_ES, da_DK, de_DE, el_GR, en, es_ES, fi_FI, fil_PH, fr_FR, ga_IE, hi_IN, hu_HU, is_IS, it_IT, ja_JP, ko_KR, lt_LT, nb_NO, nl_NL, pl_PL, pt_BR, pt_PT, ru_RU, si_LK, sv_SE, ta_IN, th_TH, tr_TR, uz_UZ, vi_VN or zh_CN. It never affects anything the person themselves wrote."
                                                        },
                                                        "timezone": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The zone their times are shown in, as an identifier such as Europe/Paris, up to 64 characters. Every timestamp in this API is a count of seconds regardless, so this is about what a screen shows rather than about what you receive."
                                                        },
                                                        "time_format": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either 24 or 12, saying which clock they read."
                                                        },
                                                        "date_format": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How a date is written for them: one of d/m/Y, m/d/Y, Y-m-d or j F Y, or null when they have not chosen and the language decides."
                                                        },
                                                        "name_order": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either given_first or family_first. Which name comes first varies by culture, so it is a setting rather than an assumption."
                                                        },
                                                        "number_format": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How a number is grouped and pointed: one of comma_dot, dot_comma, space_comma or no_separator, or null when they have not chosen and the language decides."
                                                        },
                                                        "contact_list_grouping": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Which people the contact list was last showing them: one of all, favourites or names-only, or null until they have opened the list."
                                                        },
                                                        "contact_list_sort": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the contact list was last ordered by: one of name, nickname, last-spoke or added, or null until they have opened the list."
                                                        },
                                                        "contact_list_direction": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Which way round that order ran: asc or desc, or null until they have opened the list."
                                                        },
                                                        "shows_vault_list": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the person lands on the list of their vaults, or goes straight to their default vault. True until they turn it off. While it is false, their default vault cannot be deleted."
                                                        },
                                                        "welcomed_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the user dismissed the welcome screen, as a count of seconds, or null if they have not."
                                                        },
                                                        "full_access_offer_dismissed_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the user hid the banner offering full access, as a count of seconds, or null if they have not."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the account was opened, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the profile last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "user",
                                        "id": "1",
                                        "attributes": {
                                            "first_name": "Michael",
                                            "last_name": "Scott",
                                            "email": "michael.scott@dundermifflin.com",
                                            "email_verified": true,
                                            "locale": "en",
                                            "timezone": "America/New_York",
                                            "time_format": "24",
                                            "date_format": null,
                                            "name_order": "given_first",
                                            "number_format": null,
                                            "contact_list_grouping": "favourites",
                                            "contact_list_sort": "last-spoke",
                                            "contact_list_direction": "desc",
                                            "shows_vault_list": true,
                                            "welcomed_at": 1756252860,
                                            "full_access_offer_dismissed_at": null,
                                            "created_at": 1756252800,
                                            "updated_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/me"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/me/full-access-offer": {
            "put": {
                "operationId": "me-full-access-offer-update",
                "tags": [
                    "Your profile"
                ],
                "summary": "Hide the offer of full access",
                "description": "Record that the user the token belongs to no longer wants the banner offering full access.\n\nA free account sees a banner offering full access at the top of the web application. An application that lets its reader hide it calls this, so the banner is gone on every device.\n\nHiding it twice keeps the first moment. Nothing brings the banner back, not even a later change of access.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "responses": {
                    "200": {
                        "description": "The updated user object.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The person the token acts as.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always user. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "first_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The given name, up to 255 characters. Which of the two names is shown first is name_order rather than this."
                                                        },
                                                        "last_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The family name, up to 255 characters."
                                                        },
                                                        "email": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The address the account signs in with, up to 255 characters, always in lower case. It is unique across the instance."
                                                        },
                                                        "email_verified": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the address has been confirmed. Worked out from when it was confirmed rather than stored as a flag, so the moment itself is not something the API hands out."
                                                        },
                                                        "locale": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The language the product speaks to this person: one of bn_BD, ca_ES, da_DK, de_DE, el_GR, en, es_ES, fi_FI, fil_PH, fr_FR, ga_IE, hi_IN, hu_HU, is_IS, it_IT, ja_JP, ko_KR, lt_LT, nb_NO, nl_NL, pl_PL, pt_BR, pt_PT, ru_RU, si_LK, sv_SE, ta_IN, th_TH, tr_TR, uz_UZ, vi_VN or zh_CN. It never affects anything the person themselves wrote."
                                                        },
                                                        "timezone": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The zone their times are shown in, as an identifier such as Europe/Paris, up to 64 characters. Every timestamp in this API is a count of seconds regardless, so this is about what a screen shows rather than about what you receive."
                                                        },
                                                        "time_format": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either 24 or 12, saying which clock they read."
                                                        },
                                                        "date_format": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How a date is written for them: one of d/m/Y, m/d/Y, Y-m-d or j F Y, or null when they have not chosen and the language decides."
                                                        },
                                                        "name_order": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either given_first or family_first. Which name comes first varies by culture, so it is a setting rather than an assumption."
                                                        },
                                                        "number_format": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How a number is grouped and pointed: one of comma_dot, dot_comma, space_comma or no_separator, or null when they have not chosen and the language decides."
                                                        },
                                                        "contact_list_grouping": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Which people the contact list was last showing them: one of all, favourites or names-only, or null until they have opened the list."
                                                        },
                                                        "contact_list_sort": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the contact list was last ordered by: one of name, nickname, last-spoke or added, or null until they have opened the list."
                                                        },
                                                        "contact_list_direction": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Which way round that order ran: asc or desc, or null until they have opened the list."
                                                        },
                                                        "shows_vault_list": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the person lands on the list of their vaults, or goes straight to their default vault. True until they turn it off. While it is false, their default vault cannot be deleted."
                                                        },
                                                        "welcomed_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the user dismissed the welcome screen, as a count of seconds, or null if they have not."
                                                        },
                                                        "full_access_offer_dismissed_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the user hid the banner offering full access, as a count of seconds, or null if they have not."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the account was opened, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the profile last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "user",
                                        "id": "1",
                                        "attributes": {
                                            "first_name": "Michael",
                                            "last_name": "Scott",
                                            "email": "michael.scott@dundermifflin.com",
                                            "email_verified": true,
                                            "locale": "en",
                                            "timezone": "America/New_York",
                                            "time_format": "24",
                                            "date_format": null,
                                            "name_order": "given_first",
                                            "number_format": null,
                                            "contact_list_grouping": "favourites",
                                            "contact_list_sort": "last-spoke",
                                            "contact_list_direction": "desc",
                                            "shows_vault_list": true,
                                            "welcomed_at": 1756252860,
                                            "full_access_offer_dismissed_at": null,
                                            "created_at": 1756252800,
                                            "updated_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/me"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/me/timezone": {
            "put": {
                "operationId": "me-timezone-update",
                "tags": [
                    "Your profile"
                ],
                "summary": "Set your time zone",
                "description": "Set the time zone the user the token belongs to reads dates in.\n\nThe zone has to be one of the 419 canonical IANA identifiers, which is the same set the interface offers. The deprecated aliases such as US/Pacific are refused, and so are the bare offsets under Etc. Anything else comes back 422 with the stored zone untouched.\n\nIt changes rendering and nothing else. No stored value is rewritten, and no reminder already computed moves: a reminder rule freezes the zone it was created in.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "timezone": {
                                        "type": "string",
                                        "description": "An IANA time zone identifier. Maximum 64 characters."
                                    }
                                },
                                "required": [
                                    "timezone"
                                ]
                            },
                            "example": {
                                "timezone": "Europe/Lisbon"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The updated user object.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The person the token acts as.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always user. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "first_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The given name, up to 255 characters. Which of the two names is shown first is name_order rather than this."
                                                        },
                                                        "last_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The family name, up to 255 characters."
                                                        },
                                                        "email": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The address the account signs in with, up to 255 characters, always in lower case. It is unique across the instance."
                                                        },
                                                        "email_verified": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the address has been confirmed. Worked out from when it was confirmed rather than stored as a flag, so the moment itself is not something the API hands out."
                                                        },
                                                        "locale": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The language the product speaks to this person: one of bn_BD, ca_ES, da_DK, de_DE, el_GR, en, es_ES, fi_FI, fil_PH, fr_FR, ga_IE, hi_IN, hu_HU, is_IS, it_IT, ja_JP, ko_KR, lt_LT, nb_NO, nl_NL, pl_PL, pt_BR, pt_PT, ru_RU, si_LK, sv_SE, ta_IN, th_TH, tr_TR, uz_UZ, vi_VN or zh_CN. It never affects anything the person themselves wrote."
                                                        },
                                                        "timezone": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The zone their times are shown in, as an identifier such as Europe/Paris, up to 64 characters. Every timestamp in this API is a count of seconds regardless, so this is about what a screen shows rather than about what you receive."
                                                        },
                                                        "time_format": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either 24 or 12, saying which clock they read."
                                                        },
                                                        "date_format": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How a date is written for them: one of d/m/Y, m/d/Y, Y-m-d or j F Y, or null when they have not chosen and the language decides."
                                                        },
                                                        "name_order": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either given_first or family_first. Which name comes first varies by culture, so it is a setting rather than an assumption."
                                                        },
                                                        "number_format": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How a number is grouped and pointed: one of comma_dot, dot_comma, space_comma or no_separator, or null when they have not chosen and the language decides."
                                                        },
                                                        "contact_list_grouping": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Which people the contact list was last showing them: one of all, favourites or names-only, or null until they have opened the list."
                                                        },
                                                        "contact_list_sort": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the contact list was last ordered by: one of name, nickname, last-spoke or added, or null until they have opened the list."
                                                        },
                                                        "contact_list_direction": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Which way round that order ran: asc or desc, or null until they have opened the list."
                                                        },
                                                        "shows_vault_list": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the person lands on the list of their vaults, or goes straight to their default vault. True until they turn it off. While it is false, their default vault cannot be deleted."
                                                        },
                                                        "welcomed_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the user dismissed the welcome screen, as a count of seconds, or null if they have not."
                                                        },
                                                        "full_access_offer_dismissed_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the user hid the banner offering full access, as a count of seconds, or null if they have not."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the account was opened, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the profile last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "user",
                                        "id": "1",
                                        "attributes": {
                                            "first_name": "Michael",
                                            "last_name": "Scott",
                                            "email": "michael.scott@dundermifflin.com",
                                            "email_verified": true,
                                            "locale": "en",
                                            "timezone": "America/New_York",
                                            "time_format": "24",
                                            "date_format": null,
                                            "name_order": "given_first",
                                            "number_format": null,
                                            "contact_list_grouping": "favourites",
                                            "contact_list_sort": "last-spoke",
                                            "contact_list_direction": "desc",
                                            "shows_vault_list": true,
                                            "welcomed_at": 1756252860,
                                            "full_access_offer_dismissed_at": null,
                                            "created_at": 1756252800,
                                            "updated_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/me"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/me/vault-list": {
            "put": {
                "operationId": "me-vault-list-update",
                "tags": [
                    "Your profile"
                ],
                "summary": "Show or skip the list of vaults",
                "description": "Choose whether the user the token belongs to lands on the list of their vaults, or goes straight to their default vault.\n\nIt is the switch Show the list of vaults on the Preferences screen. It changes where the interface takes the person, and nothing this API returns.\n\nWhile it is false, the default vault cannot be deleted: DELETE /vaults/{vault} answers 422 for it. Set it back to true first.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "shows_vault_list": {
                                        "type": "boolean",
                                        "description": "True to show the list of vaults, false to go straight to the default vault. Anything else comes back 422."
                                    }
                                },
                                "required": [
                                    "shows_vault_list"
                                ]
                            },
                            "example": {
                                "shows_vault_list": false
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The updated user object.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The person the token acts as.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always user. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "first_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The given name, up to 255 characters. Which of the two names is shown first is name_order rather than this."
                                                        },
                                                        "last_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The family name, up to 255 characters."
                                                        },
                                                        "email": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The address the account signs in with, up to 255 characters, always in lower case. It is unique across the instance."
                                                        },
                                                        "email_verified": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the address has been confirmed. Worked out from when it was confirmed rather than stored as a flag, so the moment itself is not something the API hands out."
                                                        },
                                                        "locale": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The language the product speaks to this person: one of bn_BD, ca_ES, da_DK, de_DE, el_GR, en, es_ES, fi_FI, fil_PH, fr_FR, ga_IE, hi_IN, hu_HU, is_IS, it_IT, ja_JP, ko_KR, lt_LT, nb_NO, nl_NL, pl_PL, pt_BR, pt_PT, ru_RU, si_LK, sv_SE, ta_IN, th_TH, tr_TR, uz_UZ, vi_VN or zh_CN. It never affects anything the person themselves wrote."
                                                        },
                                                        "timezone": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The zone their times are shown in, as an identifier such as Europe/Paris, up to 64 characters. Every timestamp in this API is a count of seconds regardless, so this is about what a screen shows rather than about what you receive."
                                                        },
                                                        "time_format": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either 24 or 12, saying which clock they read."
                                                        },
                                                        "date_format": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How a date is written for them: one of d/m/Y, m/d/Y, Y-m-d or j F Y, or null when they have not chosen and the language decides."
                                                        },
                                                        "name_order": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either given_first or family_first. Which name comes first varies by culture, so it is a setting rather than an assumption."
                                                        },
                                                        "number_format": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How a number is grouped and pointed: one of comma_dot, dot_comma, space_comma or no_separator, or null when they have not chosen and the language decides."
                                                        },
                                                        "contact_list_grouping": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Which people the contact list was last showing them: one of all, favourites or names-only, or null until they have opened the list."
                                                        },
                                                        "contact_list_sort": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the contact list was last ordered by: one of name, nickname, last-spoke or added, or null until they have opened the list."
                                                        },
                                                        "contact_list_direction": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Which way round that order ran: asc or desc, or null until they have opened the list."
                                                        },
                                                        "shows_vault_list": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the person lands on the list of their vaults, or goes straight to their default vault. True until they turn it off. While it is false, their default vault cannot be deleted."
                                                        },
                                                        "welcomed_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the user dismissed the welcome screen, as a count of seconds, or null if they have not."
                                                        },
                                                        "full_access_offer_dismissed_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the user hid the banner offering full access, as a count of seconds, or null if they have not."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the account was opened, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the profile last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "user",
                                        "id": "1",
                                        "attributes": {
                                            "first_name": "Michael",
                                            "last_name": "Scott",
                                            "email": "michael.scott@dundermifflin.com",
                                            "email_verified": true,
                                            "locale": "en",
                                            "timezone": "America/New_York",
                                            "time_format": "24",
                                            "date_format": null,
                                            "name_order": "given_first",
                                            "number_format": null,
                                            "contact_list_grouping": "favourites",
                                            "contact_list_sort": "last-spoke",
                                            "contact_list_direction": "desc",
                                            "shows_vault_list": false,
                                            "welcomed_at": 1756252860,
                                            "full_access_offer_dismissed_at": null,
                                            "created_at": 1756252800,
                                            "updated_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/me"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/api-keys": {
            "get": {
                "operationId": "api-keys-index",
                "tags": [
                    "API keys"
                ],
                "summary": "List keys",
                "description": "List the keys you have minted, newest first, including the one you are calling with.\n\nA key acts as one person, so what comes back is yours and nobody else's. The key itself is not in here, in any form: it is readable once, in the response that created it, and only a hash of it is kept.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to answer with.",
                        "schema": {
                            "type": "integer",
                            "default": 1
                        }
                    },
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "How many keys one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused.",
                        "schema": {
                            "type": "integer",
                            "default": 25
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of key objects, and how many there are in all.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The keys on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One key.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always api_key. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the key is for, between 3 and 255 characters, as the person who minted it wrote it. Two keys may share a name; the id is what tells them apart."
                                                            },
                                                            "client": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the key was minted for: script for something you wrote yourself, assistant for an assistant connecting over MCP. It tells the two apart on the security screen and in your account log, and it restricts nothing: a key of either kind reaches exactly what you reach."
                                                            },
                                                            "sensitive_fields": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the key reaches the values of fields marked sensitive. False unless that was chosen when the key was minted, because a key is handed to a device and an address book on a phone can be read by the other applications on it."
                                                            },
                                                            "administration": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the key reaches the support queue of the whole instance. Only an administrator of the instance can mint such a key, and only when it was chosen at that moment."
                                                            },
                                                            "last_used_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the key last let something in, as a count of seconds, or null if it never has. A key with null here has been minted and never used."
                                                            },
                                                            "expires_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the key stops working, as a count of seconds, or null when it never does. Every key issued today is null: expiry is not something this API sets yet."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the key was minted, as a count of seconds since 1970."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the row last changed, as a count of seconds, or null. Using a key changes it, so in practice it tracks last_used_at."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "api_key",
                                            "id": "3",
                                            "attributes": {
                                                "name": "Dundie awards bot",
                                                "client": "assistant",
                                                "sensitive_fields": false,
                                                "administration": false,
                                                "last_used_at": 1756339200,
                                                "expires_at": null,
                                                "created_at": 1756252800,
                                                "updated_at": 1756252800
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/api-keys/3"
                                            }
                                        },
                                        {
                                            "type": "api_key",
                                            "id": "1",
                                            "attributes": {
                                                "name": "Deployment script",
                                                "client": "script",
                                                "sensitive_fields": false,
                                                "administration": false,
                                                "last_used_at": null,
                                                "expires_at": null,
                                                "created_at": 1756166400,
                                                "updated_at": 1756166400
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/api-keys/1"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 2
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "api-keys-index-query",
                "tags": [
                    "API keys"
                ],
                "summary": "List keys",
                "description": "List the keys you have minted, newest first, including the one you are calling with.\n\nA key acts as one person, so what comes back is yours and nobody else's. The key itself is not in here, in any form: it is readable once, in the response that created it, and only a hash of it is kept.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "page": {
                                        "type": "integer",
                                        "default": 1,
                                        "description": "Which page to answer with."
                                    },
                                    "per_page": {
                                        "type": "integer",
                                        "default": 25,
                                        "description": "How many keys one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "A page of key objects, and how many there are in all.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The keys on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One key.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always api_key. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the key is for, between 3 and 255 characters, as the person who minted it wrote it. Two keys may share a name; the id is what tells them apart."
                                                            },
                                                            "client": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the key was minted for: script for something you wrote yourself, assistant for an assistant connecting over MCP. It tells the two apart on the security screen and in your account log, and it restricts nothing: a key of either kind reaches exactly what you reach."
                                                            },
                                                            "sensitive_fields": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the key reaches the values of fields marked sensitive. False unless that was chosen when the key was minted, because a key is handed to a device and an address book on a phone can be read by the other applications on it."
                                                            },
                                                            "administration": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the key reaches the support queue of the whole instance. Only an administrator of the instance can mint such a key, and only when it was chosen at that moment."
                                                            },
                                                            "last_used_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the key last let something in, as a count of seconds, or null if it never has. A key with null here has been minted and never used."
                                                            },
                                                            "expires_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the key stops working, as a count of seconds, or null when it never does. Every key issued today is null: expiry is not something this API sets yet."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the key was minted, as a count of seconds since 1970."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the row last changed, as a count of seconds, or null. Using a key changes it, so in practice it tracks last_used_at."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "api_key",
                                            "id": "3",
                                            "attributes": {
                                                "name": "Dundie awards bot",
                                                "client": "assistant",
                                                "sensitive_fields": false,
                                                "administration": false,
                                                "last_used_at": 1756339200,
                                                "expires_at": null,
                                                "created_at": 1756252800,
                                                "updated_at": 1756252800
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/api-keys/3"
                                            }
                                        },
                                        {
                                            "type": "api_key",
                                            "id": "1",
                                            "attributes": {
                                                "name": "Deployment script",
                                                "client": "script",
                                                "sensitive_fields": false,
                                                "administration": false,
                                                "last_used_at": null,
                                                "expires_at": null,
                                                "created_at": 1756166400,
                                                "updated_at": 1756166400
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/api-keys/1"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 2
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "post": {
                "operationId": "api-keys-create",
                "tags": [
                    "API keys"
                ],
                "summary": "Create a key",
                "description": "Mint a key, which acts as you and nobody else.\n\nThe readable value comes back in the token field, beside the object describing the key. This is the only time it exists in that form. Copy it now: it is not shown again, and a key you fail to copy is replaced rather than recovered.\n\nCalling this with a key is deliberate, and it is how a key is rotated without opening the application. Every creation is written to your account log, so a key that mints other keys is visible afterwards.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "description": "What the key is for, in a few words. Between 3 and 255 characters. Two keys may share a name; the id is what tells them apart."
                                    },
                                    "client": {
                                        "type": "string",
                                        "description": "What will use the key: script, which is what it is when left out, or assistant for an assistant connecting over MCP. It describes the key and restricts nothing."
                                    },
                                    "sensitive_fields": {
                                        "type": "boolean",
                                        "description": "Whether this key may read the values of fields marked sensitive. False when it is left out. Turn it on only for a device that needs them. A key can only give another key a scope it holds itself, so a key without this scope gets 422 on sensitive_fields."
                                    },
                                    "administration": {
                                        "type": "boolean",
                                        "description": "Whether this key may work through the support queue of the whole instance. False when it is left out. Only an administrator of the instance may turn it on, and only with a key that holds the administration scope itself; anybody else gets 422 on administration."
                                    }
                                },
                                "required": [
                                    "name"
                                ]
                            },
                            "example": {
                                "name": "Dundie awards bot",
                                "client": "assistant",
                                "sensitive_fields": false,
                                "administration": false
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The new key object, and the readable key beside it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The key.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always api_key. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the key is for, between 3 and 255 characters, as the person who minted it wrote it. Two keys may share a name; the id is what tells them apart."
                                                        },
                                                        "client": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the key was minted for: script for something you wrote yourself, assistant for an assistant connecting over MCP. It tells the two apart on the security screen and in your account log, and it restricts nothing: a key of either kind reaches exactly what you reach."
                                                        },
                                                        "sensitive_fields": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the key reaches the values of fields marked sensitive. False unless that was chosen when the key was minted, because a key is handed to a device and an address book on a phone can be read by the other applications on it."
                                                        },
                                                        "administration": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the key reaches the support queue of the whole instance. Only an administrator of the instance can mint such a key, and only when it was chosen at that moment."
                                                        },
                                                        "last_used_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the key last let something in, as a count of seconds, or null if it never has. A key with null here has been minted and never used."
                                                        },
                                                        "expires_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the key stops working, as a count of seconds, or null when it never does. Every key issued today is null: expiry is not something this API sets yet."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the key was minted, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the row last changed, as a count of seconds, or null. Using a key changes it, so in practice it tracks last_used_at."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "token": {
                                            "type": [
                                                "string",
                                                "null"
                                            ],
                                            "description": "The readable key, at the top of the answer rather than inside the object, because the shape describing a key is one that can never carry a secret. This is the only time it exists in this form: only a hash of it is kept, so a key you fail to copy has to be replaced rather than recovered."
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "api_key",
                                        "id": "4",
                                        "attributes": {
                                            "name": "Dundie awards bot",
                                            "client": "assistant",
                                            "sensitive_fields": false,
                                            "administration": false,
                                            "last_used_at": null,
                                            "expires_at": null,
                                            "created_at": 1756425600,
                                            "updated_at": 1756425600
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/api-keys/4"
                                        }
                                    },
                                    "token": "4|f9aB2cD3eF4gH5iJ6kL7mN8oP9qR0sT1uV2w"
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/api-keys/{apiKey}": {
            "get": {
                "operationId": "api-keys-show",
                "tags": [
                    "API keys"
                ],
                "summary": "Get a key",
                "description": "Retrieve one of your keys: what you called it, when you made it, and when it last let something in.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "apiKey",
                        "in": "path",
                        "required": true,
                        "description": "The id of the key.",
                        "schema": {
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A key object. A key belonging to somebody else answers 404, which is also what a key that never existed answers.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The key.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always api_key. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the key is for, between 3 and 255 characters, as the person who minted it wrote it. Two keys may share a name; the id is what tells them apart."
                                                        },
                                                        "client": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the key was minted for: script for something you wrote yourself, assistant for an assistant connecting over MCP. It tells the two apart on the security screen and in your account log, and it restricts nothing: a key of either kind reaches exactly what you reach."
                                                        },
                                                        "sensitive_fields": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the key reaches the values of fields marked sensitive. False unless that was chosen when the key was minted, because a key is handed to a device and an address book on a phone can be read by the other applications on it."
                                                        },
                                                        "administration": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the key reaches the support queue of the whole instance. Only an administrator of the instance can mint such a key, and only when it was chosen at that moment."
                                                        },
                                                        "last_used_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the key last let something in, as a count of seconds, or null if it never has. A key with null here has been minted and never used."
                                                        },
                                                        "expires_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the key stops working, as a count of seconds, or null when it never does. Every key issued today is null: expiry is not something this API sets yet."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the key was minted, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the row last changed, as a count of seconds, or null. Using a key changes it, so in practice it tracks last_used_at."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "api_key",
                                        "id": "3",
                                        "attributes": {
                                            "name": "Dundie awards bot",
                                            "client": "assistant",
                                            "sensitive_fields": false,
                                            "administration": false,
                                            "last_used_at": 1756339200,
                                            "expires_at": null,
                                            "created_at": 1756252800,
                                            "updated_at": 1756252800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/api-keys/3"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "api-keys-show-query",
                "tags": [
                    "API keys"
                ],
                "summary": "Get a key",
                "description": "Retrieve one of your keys: what you called it, when you made it, and when it last let something in.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "apiKey",
                        "in": "path",
                        "required": true,
                        "description": "The id of the key.",
                        "schema": {
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A key object. A key belonging to somebody else answers 404, which is also what a key that never existed answers.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The key.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always api_key. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the key is for, between 3 and 255 characters, as the person who minted it wrote it. Two keys may share a name; the id is what tells them apart."
                                                        },
                                                        "client": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the key was minted for: script for something you wrote yourself, assistant for an assistant connecting over MCP. It tells the two apart on the security screen and in your account log, and it restricts nothing: a key of either kind reaches exactly what you reach."
                                                        },
                                                        "sensitive_fields": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the key reaches the values of fields marked sensitive. False unless that was chosen when the key was minted, because a key is handed to a device and an address book on a phone can be read by the other applications on it."
                                                        },
                                                        "administration": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the key reaches the support queue of the whole instance. Only an administrator of the instance can mint such a key, and only when it was chosen at that moment."
                                                        },
                                                        "last_used_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the key last let something in, as a count of seconds, or null if it never has. A key with null here has been minted and never used."
                                                        },
                                                        "expires_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the key stops working, as a count of seconds, or null when it never does. Every key issued today is null: expiry is not something this API sets yet."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the key was minted, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the row last changed, as a count of seconds, or null. Using a key changes it, so in practice it tracks last_used_at."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "api_key",
                                        "id": "3",
                                        "attributes": {
                                            "name": "Dundie awards bot",
                                            "client": "assistant",
                                            "sensitive_fields": false,
                                            "administration": false,
                                            "last_used_at": 1756339200,
                                            "expires_at": null,
                                            "created_at": 1756252800,
                                            "updated_at": 1756252800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/api-keys/3"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "delete": {
                "operationId": "api-keys-destroy",
                "tags": [
                    "API keys"
                ],
                "summary": "Delete a key",
                "description": "Revoke a key, which stops working the moment this answers.\n\nAnything still using it stops working, immediately, with nothing to wait out. Your other keys are untouched, which is the point of naming them: an integration you no longer trust can be cut off without breaking the rest.\n\nYou may revoke the key you are calling with. This call succeeds and every later call with it answers 401.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "apiKey",
                        "in": "path",
                        "required": true,
                        "description": "The id of the key.",
                        "schema": {
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Nothing at all. A key belonging to somebody else answers 404, and keeps working."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults": {
            "get": {
                "operationId": "vaults-index",
                "tags": [
                    "Vaults"
                ],
                "summary": "List vaults",
                "description": "List your vaults, in the order you arranged them.\n\nThe order is the one you gave your vaults, which is the order they appear in when you switch between them. It is not the order they were made in, so a vault you moved to the top comes back at the top.\n\nA deleted vault is never listed. An account holding no vault answers with an empty list rather than an error, since that is the state every account starts in.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to answer with.",
                        "schema": {
                            "type": "integer",
                            "default": 1
                        }
                    },
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "How many vaults one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused.",
                        "schema": {
                            "type": "integer",
                            "default": 25
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of vault objects, and how many there are in all.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The vaults on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One vault.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always vault. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "slug": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The readable name the vault is addressed by, built from its name and unique within your account. It is not stable: renaming the vault rebuilds it and the previous one stops answering, which is why a stored reference should be the id. Nothing lets you choose or edit it."
                                                            },
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the vault is called. Up to 255 characters. Reduced to plain text when it was written down, so no markup survives here."
                                                            },
                                                            "description": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the vault is for, up to 65535 characters, or null when nobody said. Null is the ordinary state of a vault nobody described, not a sign of anything missing."
                                                            },
                                                            "colour": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Exactly one of #3f5fd0, #4f8a49, #9a6a24, #9a3f2b, #6b4fa8, #2f7f86, #a8447a or #4a4a52, written in lower case. It is how vaults are told apart at a glance, and it is decoration: nothing depends on it."
                                                            },
                                                            "position": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "Where the vault sits in your list, counting from 1. It is the order you arranged, and it is the order the list endpoint answers in."
                                                            },
                                                            "is_default": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether records land here when nothing says which vault. Exactly one of your vaults is true while you hold a vault at all, and none is while you hold none."
                                                            },
                                                            "contact_count": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How many contacts the vault holds, counting the archived and the partial ones. It is a running count kept as contacts are written down and deleted, rather than something counted when you ask."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the vault was opened, as a count of seconds since 1970 rather than a written date."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When its wording last changed, as a count of seconds. Equal to created_at until it first changes."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The page of the vault in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "vault",
                                            "id": "9d4f1c2e-7b3a-4f88-9a2d-6c1e5b0f7a31",
                                            "attributes": {
                                                "slug": "dunder-mifflin",
                                                "name": "Dunder Mifflin",
                                                "description": "Everybody at the Scranton branch.",
                                                "colour": "#4f8a49",
                                                "position": 1,
                                                "is_default": true,
                                                "contact_count": 12,
                                                "created_at": 1756252800,
                                                "updated_at": 1756339200
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin",
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin"
                                            }
                                        },
                                        {
                                            "type": "vault",
                                            "id": "b17c6d40-2e59-4a1b-8f03-5d84e2a9c6f7",
                                            "attributes": {
                                                "slug": "schrute-farms",
                                                "name": "Schrute Farms",
                                                "description": null,
                                                "colour": "#9a6a24",
                                                "position": 2,
                                                "is_default": false,
                                                "contact_count": 3,
                                                "created_at": 1756166400,
                                                "updated_at": 1756166400
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/schrute-farms",
                                                "web": "https://my.monicahq.com/vaults/schrute-farms"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 2
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "vaults-index-query",
                "tags": [
                    "Vaults"
                ],
                "summary": "List vaults",
                "description": "List your vaults, in the order you arranged them.\n\nThe order is the one you gave your vaults, which is the order they appear in when you switch between them. It is not the order they were made in, so a vault you moved to the top comes back at the top.\n\nA deleted vault is never listed. An account holding no vault answers with an empty list rather than an error, since that is the state every account starts in.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "page": {
                                        "type": "integer",
                                        "default": 1,
                                        "description": "Which page to answer with."
                                    },
                                    "per_page": {
                                        "type": "integer",
                                        "default": 25,
                                        "description": "How many vaults one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "A page of vault objects, and how many there are in all.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The vaults on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One vault.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always vault. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "slug": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The readable name the vault is addressed by, built from its name and unique within your account. It is not stable: renaming the vault rebuilds it and the previous one stops answering, which is why a stored reference should be the id. Nothing lets you choose or edit it."
                                                            },
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the vault is called. Up to 255 characters. Reduced to plain text when it was written down, so no markup survives here."
                                                            },
                                                            "description": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the vault is for, up to 65535 characters, or null when nobody said. Null is the ordinary state of a vault nobody described, not a sign of anything missing."
                                                            },
                                                            "colour": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Exactly one of #3f5fd0, #4f8a49, #9a6a24, #9a3f2b, #6b4fa8, #2f7f86, #a8447a or #4a4a52, written in lower case. It is how vaults are told apart at a glance, and it is decoration: nothing depends on it."
                                                            },
                                                            "position": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "Where the vault sits in your list, counting from 1. It is the order you arranged, and it is the order the list endpoint answers in."
                                                            },
                                                            "is_default": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether records land here when nothing says which vault. Exactly one of your vaults is true while you hold a vault at all, and none is while you hold none."
                                                            },
                                                            "contact_count": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How many contacts the vault holds, counting the archived and the partial ones. It is a running count kept as contacts are written down and deleted, rather than something counted when you ask."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the vault was opened, as a count of seconds since 1970 rather than a written date."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When its wording last changed, as a count of seconds. Equal to created_at until it first changes."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The page of the vault in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "vault",
                                            "id": "9d4f1c2e-7b3a-4f88-9a2d-6c1e5b0f7a31",
                                            "attributes": {
                                                "slug": "dunder-mifflin",
                                                "name": "Dunder Mifflin",
                                                "description": "Everybody at the Scranton branch.",
                                                "colour": "#4f8a49",
                                                "position": 1,
                                                "is_default": true,
                                                "contact_count": 12,
                                                "created_at": 1756252800,
                                                "updated_at": 1756339200
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin",
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin"
                                            }
                                        },
                                        {
                                            "type": "vault",
                                            "id": "b17c6d40-2e59-4a1b-8f03-5d84e2a9c6f7",
                                            "attributes": {
                                                "slug": "schrute-farms",
                                                "name": "Schrute Farms",
                                                "description": null,
                                                "colour": "#9a6a24",
                                                "position": 2,
                                                "is_default": false,
                                                "contact_count": 3,
                                                "created_at": 1756166400,
                                                "updated_at": 1756166400
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/schrute-farms",
                                                "web": "https://my.monicahq.com/vaults/schrute-farms"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 2
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "post": {
                "operationId": "vaults-create",
                "tags": [
                    "Vaults"
                ],
                "summary": "Create a vault",
                "description": "Open a compartment. It starts empty, and it goes at the end of your list.\n\nIf your account held no vault, this one becomes the vault records land in when nothing says which. Exactly one vault is that at any time, and there was nothing else to be it.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "description": "What the vault is called. Up to 255 characters. Markup and surrounding blank space are stripped."
                                    },
                                    "description": {
                                        "type": "string",
                                        "description": "What the vault is for. Up to 65535 characters. Absent, empty or null all mean it has none."
                                    },
                                    "colour": {
                                        "type": "string",
                                        "default": "#3f5fd0",
                                        "description": "Exactly one of #3f5fd0, #4f8a49, #9a6a24, #9a3f2b, #6b4fa8, #2f7f86, #a8447a or #4a4a52, written in lower case. Absent means #3f5fd0."
                                    },
                                    "is_default": {
                                        "type": "boolean",
                                        "description": "True makes this the vault records land in when nothing says which, and takes that over from whichever vault held it. False, or saying nothing, changes nothing: exactly one of your vaults is it while you have a vault at all, so there would be nothing to hand it to."
                                    },
                                    "structure_version_id": {
                                        "type": "integer",
                                        "description": "The published version of one of your active contact templates. Every new contact in this vault starts from it, beginning with the contact standing for you, which is created with the vault. Left out, the vault starts from Basic contact, or from the next template Monica supplied when Basic contact is gone. A draft, a version belonging to somebody else, and a version describing something other than a contact are each refused."
                                    }
                                },
                                "required": [
                                    "name"
                                ]
                            },
                            "example": {
                                "name": "Dunder Mifflin",
                                "description": "Everybody at the Scranton branch.",
                                "colour": "#4f8a49"
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The new vault object. Keep its id: every other call here names the vault by it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The vault.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always vault. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "slug": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The readable name the vault is addressed by, built from its name and unique within your account. It is not stable: renaming the vault rebuilds it and the previous one stops answering, which is why a stored reference should be the id. Nothing lets you choose or edit it."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the vault is called. Up to 255 characters. Reduced to plain text when it was written down, so no markup survives here."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the vault is for, up to 65535 characters, or null when nobody said. Null is the ordinary state of a vault nobody described, not a sign of anything missing."
                                                        },
                                                        "colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Exactly one of #3f5fd0, #4f8a49, #9a6a24, #9a3f2b, #6b4fa8, #2f7f86, #a8447a or #4a4a52, written in lower case. It is how vaults are told apart at a glance, and it is decoration: nothing depends on it."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the vault sits in your list, counting from 1. It is the order you arranged, and it is the order the list endpoint answers in."
                                                        },
                                                        "is_default": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether records land here when nothing says which vault. Exactly one of your vaults is true while you hold a vault at all, and none is while you hold none."
                                                        },
                                                        "contact_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many contacts the vault holds, counting the archived and the partial ones. It is a running count kept as contacts are written down and deleted, rather than something counted when you ask."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the vault was opened, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When its wording last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The page of the vault in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "vault",
                                        "id": "9d4f1c2e-7b3a-4f88-9a2d-6c1e5b0f7a31",
                                        "attributes": {
                                            "slug": "dunder-mifflin",
                                            "name": "Dunder Mifflin",
                                            "description": "Everybody at the Scranton branch.",
                                            "colour": "#4f8a49",
                                            "position": 1,
                                            "is_default": true,
                                            "contact_count": 12,
                                            "created_at": 1756252800,
                                            "updated_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}": {
            "get": {
                "operationId": "vaults-show",
                "tags": [
                    "Vaults"
                ],
                "summary": "Get a vault",
                "description": "Retrieve one of your vaults: what it is called, what it is for, and how many contacts it holds.\n\nA vault is a watertight compartment. Contacts, records of the kinds you invented, files and private links belong to exactly one, and nothing reaches across.\n\nWhat a new contact in the vault starts from is not in here. A vault holds one of those per kind of record, so a single field would answer a narrower question than its name suggests. You can set the contact one when you create or update a vault, and reading them back is an endpoint of its own.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault, named either by the readable name it reports as slug or by its id. Both answer, whichever the account builds its own addresses from. A readable name is rebuilt whenever the record is renamed, and the previous one stops answering, so a client that stores a reference stores the id. A name a record has released is never given to another.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A vault object. A vault belonging to somebody else answers 404, which is also what a vault that never existed answers, and what a deleted one answers.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The vault.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always vault. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "slug": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The readable name the vault is addressed by, built from its name and unique within your account. It is not stable: renaming the vault rebuilds it and the previous one stops answering, which is why a stored reference should be the id. Nothing lets you choose or edit it."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the vault is called. Up to 255 characters. Reduced to plain text when it was written down, so no markup survives here."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the vault is for, up to 65535 characters, or null when nobody said. Null is the ordinary state of a vault nobody described, not a sign of anything missing."
                                                        },
                                                        "colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Exactly one of #3f5fd0, #4f8a49, #9a6a24, #9a3f2b, #6b4fa8, #2f7f86, #a8447a or #4a4a52, written in lower case. It is how vaults are told apart at a glance, and it is decoration: nothing depends on it."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the vault sits in your list, counting from 1. It is the order you arranged, and it is the order the list endpoint answers in."
                                                        },
                                                        "is_default": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether records land here when nothing says which vault. Exactly one of your vaults is true while you hold a vault at all, and none is while you hold none."
                                                        },
                                                        "contact_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many contacts the vault holds, counting the archived and the partial ones. It is a running count kept as contacts are written down and deleted, rather than something counted when you ask."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the vault was opened, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When its wording last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The page of the vault in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "vault",
                                        "id": "9d4f1c2e-7b3a-4f88-9a2d-6c1e5b0f7a31",
                                        "attributes": {
                                            "slug": "dunder-mifflin",
                                            "name": "Dunder Mifflin",
                                            "description": "Everybody at the Scranton branch.",
                                            "colour": "#4f8a49",
                                            "position": 1,
                                            "is_default": true,
                                            "contact_count": 12,
                                            "created_at": 1756252800,
                                            "updated_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "vaults-show-query",
                "tags": [
                    "Vaults"
                ],
                "summary": "Get a vault",
                "description": "Retrieve one of your vaults: what it is called, what it is for, and how many contacts it holds.\n\nA vault is a watertight compartment. Contacts, records of the kinds you invented, files and private links belong to exactly one, and nothing reaches across.\n\nWhat a new contact in the vault starts from is not in here. A vault holds one of those per kind of record, so a single field would answer a narrower question than its name suggests. You can set the contact one when you create or update a vault, and reading them back is an endpoint of its own.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault, named either by the readable name it reports as slug or by its id. Both answer, whichever the account builds its own addresses from. A readable name is rebuilt whenever the record is renamed, and the previous one stops answering, so a client that stores a reference stores the id. A name a record has released is never given to another.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A vault object. A vault belonging to somebody else answers 404, which is also what a vault that never existed answers, and what a deleted one answers.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The vault.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always vault. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "slug": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The readable name the vault is addressed by, built from its name and unique within your account. It is not stable: renaming the vault rebuilds it and the previous one stops answering, which is why a stored reference should be the id. Nothing lets you choose or edit it."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the vault is called. Up to 255 characters. Reduced to plain text when it was written down, so no markup survives here."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the vault is for, up to 65535 characters, or null when nobody said. Null is the ordinary state of a vault nobody described, not a sign of anything missing."
                                                        },
                                                        "colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Exactly one of #3f5fd0, #4f8a49, #9a6a24, #9a3f2b, #6b4fa8, #2f7f86, #a8447a or #4a4a52, written in lower case. It is how vaults are told apart at a glance, and it is decoration: nothing depends on it."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the vault sits in your list, counting from 1. It is the order you arranged, and it is the order the list endpoint answers in."
                                                        },
                                                        "is_default": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether records land here when nothing says which vault. Exactly one of your vaults is true while you hold a vault at all, and none is while you hold none."
                                                        },
                                                        "contact_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many contacts the vault holds, counting the archived and the partial ones. It is a running count kept as contacts are written down and deleted, rather than something counted when you ask."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the vault was opened, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When its wording last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The page of the vault in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "vault",
                                        "id": "9d4f1c2e-7b3a-4f88-9a2d-6c1e5b0f7a31",
                                        "attributes": {
                                            "slug": "dunder-mifflin",
                                            "name": "Dunder Mifflin",
                                            "description": "Everybody at the Scranton branch.",
                                            "colour": "#4f8a49",
                                            "position": 1,
                                            "is_default": true,
                                            "contact_count": 12,
                                            "created_at": 1756252800,
                                            "updated_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "put": {
                "operationId": "vaults-update",
                "tags": [
                    "Vaults"
                ],
                "summary": "Update a vault",
                "description": "Change what a vault is called, what it is for, and the colour it is told apart by.\n\nSend only what changes. A name or a colour sent as null is refused with 422, and a description sent as null is cleared.\n\nWhat the vault holds is untouched, and so are its place in your list and whether it is the vault records land in by default.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault, named either by the readable name it reports as slug or by its id. Both answer, whichever the account builds its own addresses from. A readable name is rebuilt whenever the record is renamed, and the previous one stops answering, so a client that stores a reference stores the id. A name a record has released is never given to another.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "description": "What the vault is called. Up to 255 characters. It cannot be null."
                                    },
                                    "description": {
                                        "type": "string",
                                        "description": "What the vault is for. Up to 65535 characters. Null clears it."
                                    },
                                    "colour": {
                                        "type": "string",
                                        "description": "Exactly one of #3f5fd0, #4f8a49, #9a6a24, #9a3f2b, #6b4fa8, #2f7f86, #a8447a or #4a4a52, written in lower case."
                                    },
                                    "is_default": {
                                        "type": "boolean",
                                        "description": "True makes this the vault records land in when nothing says which, and takes that over from whichever vault held it. False, or saying nothing, changes nothing: exactly one of your vaults is it while you have a vault at all, so there would be nothing to hand it to."
                                    },
                                    "structure_version_id": {
                                        "type": "integer",
                                        "description": "The published version of one of your active contact templates. A new contact in this vault starts from it. Contacts already created keep the version they were created on. A draft, a version belonging to somebody else, and a version describing something other than a contact are each refused."
                                    }
                                }
                            },
                            "example": {
                                "name": "Scranton",
                                "description": "The branch, and everybody who walks through it.",
                                "colour": "#9a3f2b"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The vault object as it now reads. A vault belonging to somebody else answers 404 and is left as it was.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The vault.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always vault. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "slug": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The readable name the vault is addressed by, built from its name and unique within your account. It is not stable: renaming the vault rebuilds it and the previous one stops answering, which is why a stored reference should be the id. Nothing lets you choose or edit it."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the vault is called. Up to 255 characters. Reduced to plain text when it was written down, so no markup survives here."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the vault is for, up to 65535 characters, or null when nobody said. Null is the ordinary state of a vault nobody described, not a sign of anything missing."
                                                        },
                                                        "colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Exactly one of #3f5fd0, #4f8a49, #9a6a24, #9a3f2b, #6b4fa8, #2f7f86, #a8447a or #4a4a52, written in lower case. It is how vaults are told apart at a glance, and it is decoration: nothing depends on it."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the vault sits in your list, counting from 1. It is the order you arranged, and it is the order the list endpoint answers in."
                                                        },
                                                        "is_default": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether records land here when nothing says which vault. Exactly one of your vaults is true while you hold a vault at all, and none is while you hold none."
                                                        },
                                                        "contact_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many contacts the vault holds, counting the archived and the partial ones. It is a running count kept as contacts are written down and deleted, rather than something counted when you ask."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the vault was opened, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When its wording last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The page of the vault in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "vault",
                                        "id": "9d4f1c2e-7b3a-4f88-9a2d-6c1e5b0f7a31",
                                        "attributes": {
                                            "slug": "dunder-mifflin",
                                            "name": "Dunder Mifflin",
                                            "description": "Everybody at the Scranton branch.",
                                            "colour": "#4f8a49",
                                            "position": 1,
                                            "is_default": true,
                                            "contact_count": 12,
                                            "created_at": 1756252800,
                                            "updated_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "delete": {
                "operationId": "vaults-destroy",
                "tags": [
                    "Vaults"
                ],
                "summary": "Delete a vault",
                "description": "Delete a vault and everything it separates from the rest.\n\nThis is the most destructive call here, short of deleting your account, and there is no second step: making the call is the confirmation. Read what follows before you make it.\n\nThe contacts the vault holds go with it, and so do the records of the kinds you invented. Every private link onto the vault, or onto the contacts in it, stops opening. That revocation is permanent, and bringing the vault back would not reopen them: you would decide again who may read it.\n\nIf this was the vault records land in by default, the first vault left takes that over. If no vault is left, your account has no default and holds nothing, which is the state every account starts in. The last vault of an account may be deleted.\n\nThe deletion is soft, so nothing is destroyed, but no endpoint here brings a vault back today. Treat it as final.\n\nWhile you have turned off the list of vaults (shows_vault_list is false on GET /me), your default vault cannot be deleted. The call answers 422 on vault with: You cannot delete your default vault while the list of vaults is turned off. Turn the list back on in Preferences first. Nothing is deleted. Your other vaults can still be deleted.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault, named either by the readable name it reports as slug or by its id. Both answer, whichever the account builds its own addresses from. A readable name is rebuilt whenever the record is renamed, and the previous one stops answering, so a client that stores a reference stores the id. A name a record has released is never given to another.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Nothing at all. A vault belonging to somebody else answers 404, and is not deleted. So does a vault you have already deleted, so calling this twice does not report a second deletion."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/contacts": {
            "get": {
                "operationId": "contacts-index",
                "tags": [
                    "Contacts"
                ],
                "summary": "List contacts",
                "description": "List the people one of your vaults holds, narrowed and ordered the way the people screen narrows and orders them.\n\nThe default order is by name, not by when somebody was written down, so that a program and a person looking at the same vault are looking at the same list. The order always ends on the id, which is what stops a contact being skipped or repeated by a page boundary moving while you page through.\n\nThree groups of people are never in the list you asked for. Partial contacts, somebody mentioned in a relationship and reduced to a first name, are only in names-only until they are filled in. Archived contacts and deleted contacts are in none of them at all.\n\nA vault holding nobody answers with an empty list rather than an error.\n\nEach contact also carries columns: what the people screen of this vault shows beside the name, in its order, and the values each one holds for this person. A column holding several values, somebody with two email addresses, lists them all. A column holding nothing lists nothing. The values are written the way the screen writes them, dates included, and the raw dates stay in the attributes. The columns are the ones chosen with the endpoints below, or the defaults until somebody chooses.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the contact lives in, named either by the readable name it reports as slug or by its id. Both answer.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "filter",
                        "in": "query",
                        "required": false,
                        "description": "Which people to list: all, favourites or names-only. Partial contacts are only in names-only, so all does not mean everybody the vault holds.",
                        "schema": {
                            "type": "string",
                            "default": "all"
                        }
                    },
                    {
                        "name": "query",
                        "in": "query",
                        "required": false,
                        "description": "A search term, up to 255 characters. It is matched against the whole name, ignoring what the language of the account calls a minor difference, so elodie finds Élodie in French. It is also matched against the nickname as it was typed, ignoring case.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "sort",
                        "in": "query",
                        "required": false,
                        "description": "Which order to answer in: name, nickname, last-spoke or added. A contact the order knows nothing about, somebody with no nickname when sorting by nickname, is at the end whichever direction is asked for.",
                        "schema": {
                            "type": "string",
                            "default": "name"
                        }
                    },
                    {
                        "name": "direction",
                        "in": "query",
                        "required": false,
                        "description": "Either asc or desc.",
                        "schema": {
                            "type": "string",
                            "default": "asc"
                        }
                    },
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to answer with.",
                        "schema": {
                            "type": "integer",
                            "default": 1
                        }
                    },
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "How many contacts one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused.",
                        "schema": {
                            "type": "integer",
                            "default": 25
                        }
                    },
                    {
                        "name": "categories[]",
                        "in": "query",
                        "required": false,
                        "description": "Narrow the list to the people holding any of these categories, by the ids the list of categories below gives. It narrows together with the filter. An id that is not one of your contact categories answers 422.",
                        "schema": {
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of contact objects, and how many there are in all. A vault belonging to somebody else answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The contacts on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One contact.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always contact. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "slug": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The readable name the contact is addressed by, built from the whole name above and unique within the vault. It keeps the alphabet the name is written in, so a name in Japanese is addressed in Japanese, sent as its own characters or percent encoded. It is not stable: correcting the name rebuilds it and the previous one stops answering, which is why a stored reference should be the id. Nothing lets you choose or edit it."
                                                            },
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The name the contact is shown under: the formatted name of the way of writing it chosen for display, else its parts in the order it reads in. It is what the lists sort on, and it is built rather than stored, so it cannot be written directly."
                                                            },
                                                            "formatted_name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The full name exactly as written for the way of writing it chosen for display, or null when that way is only parts."
                                                            },
                                                            "name_representations": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "Every way the current name is written: in its own script, transliterated into another, or as it is pronounced, in the order the owner put them. Every one of them finds the contact in a search. Nothing is transliterated for you.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One way of writing the name.",
                                                                    "properties": {
                                                                        "id": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "format": "uuid",
                                                                            "description": "The id of this way of writing the name. Send it back to keep it when the list is replaced."
                                                                        },
                                                                        "kind": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "written for the name in a script of its own, transliteration for the name carried into another script, phonetic for how it is pronounced."
                                                                        },
                                                                        "language": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "A BCP 47 language tag such as ko or ja, or null."
                                                                        },
                                                                        "script": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "An ISO 15924 script code such as Hang, Hani or Latn, or null."
                                                                        },
                                                                        "phonetic_system": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "For a pronunciation, the system it is written in, as the vCard PHONETIC parameter names it: ipa, piny, x-romaji, x-rr, x-other, or a token a device sent. Null for any other kind."
                                                                        },
                                                                        "formatted_name": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The full name exactly as it should appear, up to 255 characters, or null to build it from the parts. Always null for a pronunciation, which is written in its parts."
                                                                        },
                                                                        "prefix": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "Up to 50 characters, or null."
                                                                        },
                                                                        "given_name": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "Up to 255 characters, or null."
                                                                        },
                                                                        "additional_name": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "Other given names, up to 255 characters, or null."
                                                                        },
                                                                        "family_name": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "Up to 255 characters, or null."
                                                                        },
                                                                        "suffix": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "Up to 50 characters, or null."
                                                                        },
                                                                        "name_order": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "Either given_first or family_first, or null to leave it to the reader."
                                                                        },
                                                                        "position": {
                                                                            "type": [
                                                                                "integer",
                                                                                "null"
                                                                            ],
                                                                            "description": "Where it stands in the list, from 1."
                                                                        },
                                                                        "is_display": {
                                                                            "type": [
                                                                                "boolean",
                                                                                "null"
                                                                            ],
                                                                            "description": "Whether this is the way the contact is shown under, in lists, titles, notifications and initials. Exactly one is, whenever the contact has a name."
                                                                        }
                                                                    }
                                                                }
                                                            },
                                                            "prefix": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What comes before the name, up to 50 characters, or null. Dr and Sir are prefixes."
                                                            },
                                                            "first_name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The given name of the way of writing the name chosen for display, up to 255 characters, or null. Like the prefix, the middle name, the last name, the suffix and the name order, it is a copy read from that way of writing it."
                                                            },
                                                            "middle_name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Up to 255 characters, or null."
                                                            },
                                                            "last_name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The family name, up to 255 characters, or null."
                                                            },
                                                            "suffix": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What comes after the name, up to 50 characters, or null. Jr and PhD are suffixes."
                                                            },
                                                            "maiden_name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Up to 255 characters, or null."
                                                            },
                                                            "nickname": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What this person is actually called, up to 255 characters, or null. It is searched as it was typed rather than folded, and it is what the whole name falls back to when no other part is set."
                                                            },
                                                            "name_order": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Either given_first or family_first, or null to leave it to the reader. It is a fact about this person rather than a preference of yours, which is what lets a Japanese name keep its order in a list of western ones."
                                                            },
                                                            "initials": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The one or two letters drawn when the contact has no picture. Built from the name, so it cannot be written."
                                                            },
                                                            "avatar_colour": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The background those initials are drawn on, as a hex colour. It is chosen when the contact is written down and never changes afterwards, so somebody who has learnt to spot a face in a list does not have it move."
                                                            },
                                                            "avatar": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The picture, or null when the contact is drawn as its initials.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the file the picture was stored as. It is a file of the vault like any other, so it counts against your storage."
                                                                    },
                                                                    "url": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Where the picture is served from. This address is served by the application and needs a signed in session rather than a token: no endpoint here streams a vault's files yet, and a document is as private as the record it sits on."
                                                                    }
                                                                }
                                                            },
                                                            "is_favourite": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the contact sits at the top of the list."
                                                            },
                                                            "is_archived": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the contact has been put away. An archived contact is left out of every list. Reading this is possible here; changing it is not, because no screen offers the gesture either."
                                                            },
                                                            "is_partial": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the contact is somebody mentioned in a relationship and reduced to a first name. A partial contact is off every list until somebody fills them in, so it is listed by no filter at all."
                                                            },
                                                            "is_me": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether this contact represents you. Exactly one contact per vault is, it cannot be deleted, and nothing here hands the title to somebody else."
                                                            },
                                                            "age": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How old the contact is in whole years, on your current day in your time zone. Null when the birthday is not recorded, when its year or its month is unknown, or when its date lies in the future. Null too when the birthday field is sensitive and the key lacks the sensitive-fields ability. It is worked out on every read and never stored."
                                                            },
                                                            "next_birthday_on": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The next birthday as a date written Y-m-d, on or after your current day in your time zone, so it is today's date on the birthday itself. A birthday on 29 February falls on 28 February in a year without one. Null when the birthday is not recorded, when its month is unknown, or when the birthday field is sensitive and the key lacks the sensitive-fields ability."
                                                            },
                                                            "structure_version_id": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "The published version of the template this contact renders from. It says what pages the contact has and what is written on them. Publishing a new version moves nobody: a contact stays on the version it points at until it is moved."
                                                            },
                                                            "template_name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What that template is called, which is what the lists show beside a contact."
                                                            },
                                                            "categories": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "The categories the contact holds, in the order of your list of contact categories. A category is a choice of that list held in any field of the template drawing on it. Empty when the contact holds none.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One category.",
                                                                    "properties": {
                                                                        "id": {
                                                                            "type": [
                                                                                "integer",
                                                                                "null"
                                                                            ],
                                                                            "description": "The id of the category, which is what the list of contacts filters on."
                                                                        },
                                                                        "label": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "What the category is called, in the language of the request for a category the application supplied."
                                                                        }
                                                                    }
                                                                }
                                                            },
                                                            "last_life_event_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the contact last took part in a life event, as a count of seconds since 1970, or null when they never have. It says nothing about whether you were there."
                                                            },
                                                            "last_interaction_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "The Last in touch date: the day of the latest life event the contact took part in that has already happened and whose nature has updates_last_in_touch, as a count of seconds since 1970, or null when there is none. This is what Last in touch and Last spoke read."
                                                            },
                                                            "last_consulted_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the contact was last consulted on their own, as a count of seconds since 1970, or null when they never have been: their page opened in Monica, the contact read through this endpoint, or read by an assistant connected over MCP. Listing contacts does not change it."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the contact was written down, as a count of seconds since 1970 rather than a written date."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the contact last changed, as a count of seconds. Equal to created_at until it first changes."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The page of the contact in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                            }
                                                        }
                                                    },
                                                    "columns": {
                                                        "type": [
                                                            "array",
                                                            "null"
                                                        ],
                                                        "description": "What the people screen of this vault shows beside the name, in its order. Hidden columns, and columns no template supplies any more, are left out.",
                                                        "items": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "One column.",
                                                            "properties": {
                                                                "source": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What the column shows, one of the sources the column endpoints below list."
                                                                },
                                                                "section": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "For a field of a template, the section holding it, or null."
                                                                },
                                                                "field_key": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "For a field of a template, its key inside the section, or null."
                                                                },
                                                                "values": {
                                                                    "type": [
                                                                        "array",
                                                                        "null"
                                                                    ],
                                                                    "description": "What this person holds in the column, written the way the screen writes it. Empty when they hold nothing.",
                                                                    "items": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "One value."
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "contact",
                                            "id": "c4a1f7b2-8e36-4d59-b0a7-2f5c9d81e364",
                                            "attributes": {
                                                "slug": "pam-beesly",
                                                "name": "Pam Beesly",
                                                "formatted_name": null,
                                                "name_representations": [
                                                    {
                                                        "id": "0e6d3b1a-52c7-4f9e-8a41-b7d2c96f0e13",
                                                        "kind": "written",
                                                        "language": null,
                                                        "script": null,
                                                        "phonetic_system": null,
                                                        "formatted_name": null,
                                                        "prefix": null,
                                                        "given_name": "Pam",
                                                        "additional_name": null,
                                                        "family_name": "Beesly",
                                                        "suffix": null,
                                                        "name_order": "given_first",
                                                        "position": 1,
                                                        "is_display": true
                                                    }
                                                ],
                                                "prefix": null,
                                                "first_name": "Pam",
                                                "middle_name": null,
                                                "last_name": "Beesly",
                                                "suffix": null,
                                                "maiden_name": null,
                                                "nickname": "Pammy",
                                                "name_order": "given_first",
                                                "initials": "PB",
                                                "avatar_colour": "#0ea5e9",
                                                "avatar": {
                                                    "id": "3f6c1d90-4b27-4e85-a1c3-9d720f5b8e46",
                                                    "url": "https://my.monicahq.com/api/v1/vaults/9d4f1c2e-7b3a-4f88-9a2d-6c1e5b0f7a31/files/3f6c1d90-4b27-4e85-a1c3-9d720f5b8e46"
                                                },
                                                "is_favourite": true,
                                                "is_archived": false,
                                                "is_partial": false,
                                                "is_me": false,
                                                "age": 36,
                                                "next_birthday_on": "2026-03-14",
                                                "structure_version_id": 4,
                                                "template_name": "Default contact",
                                                "categories": [
                                                    {
                                                        "id": 12,
                                                        "label": "Colleague"
                                                    }
                                                ],
                                                "last_life_event_at": null,
                                                "created_at": 1756252800,
                                                "last_interaction_at": null,
                                                "last_consulted_at": 1756339200,
                                                "updated_at": 1756339200
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/pam-beesly",
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/contacts/pam-beesly"
                                            },
                                            "columns": [
                                                {
                                                    "source": "email",
                                                    "section": null,
                                                    "field_key": null,
                                                    "values": [
                                                        "pam@dundermifflin.com",
                                                        "pambeesly@gmail.com"
                                                    ]
                                                },
                                                {
                                                    "source": "phone",
                                                    "section": null,
                                                    "field_key": null,
                                                    "values": [
                                                        "+1 570 555 0162 (Work)"
                                                    ]
                                                },
                                                {
                                                    "source": "last-spoke",
                                                    "section": null,
                                                    "field_key": null,
                                                    "values": []
                                                }
                                            ]
                                        },
                                        {
                                            "type": "contact",
                                            "id": "7b2e9034-5c18-4af6-9d21-0e83b6c47a5f",
                                            "attributes": {
                                                "slug": "dwight-kurt-schrute",
                                                "name": "Dwight Kurt Schrute",
                                                "formatted_name": null,
                                                "name_representations": [
                                                    {
                                                        "id": "9a27c5e1-3f84-4b6d-8e02-d1b7a4c96f38",
                                                        "kind": "written",
                                                        "language": null,
                                                        "script": null,
                                                        "phonetic_system": null,
                                                        "formatted_name": null,
                                                        "prefix": null,
                                                        "given_name": "Dwight",
                                                        "additional_name": "Kurt",
                                                        "family_name": "Schrute",
                                                        "suffix": null,
                                                        "name_order": null,
                                                        "position": 1,
                                                        "is_display": true
                                                    }
                                                ],
                                                "prefix": null,
                                                "first_name": "Dwight",
                                                "middle_name": "Kurt",
                                                "last_name": "Schrute",
                                                "suffix": null,
                                                "maiden_name": null,
                                                "nickname": null,
                                                "name_order": null,
                                                "initials": "DS",
                                                "avatar_colour": "#22c55e",
                                                "avatar": null,
                                                "is_favourite": false,
                                                "is_archived": false,
                                                "is_partial": false,
                                                "is_me": false,
                                                "age": null,
                                                "next_birthday_on": null,
                                                "structure_version_id": 4,
                                                "template_name": "Default contact",
                                                "categories": [],
                                                "last_life_event_at": 1756166400,
                                                "created_at": 1756080000,
                                                "last_interaction_at": 1756166400,
                                                "last_consulted_at": null,
                                                "updated_at": 1756080000
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/dwight-kurt-schrute",
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/contacts/dwight-kurt-schrute"
                                            },
                                            "columns": [
                                                {
                                                    "source": "email",
                                                    "section": null,
                                                    "field_key": null,
                                                    "values": [
                                                        "dwight@schrutefarms.com"
                                                    ]
                                                },
                                                {
                                                    "source": "phone",
                                                    "section": null,
                                                    "field_key": null,
                                                    "values": []
                                                },
                                                {
                                                    "source": "last-spoke",
                                                    "section": null,
                                                    "field_key": null,
                                                    "values": [
                                                        "3 weeks ago"
                                                    ]
                                                }
                                            ]
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 2
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "contacts-index-query",
                "tags": [
                    "Contacts"
                ],
                "summary": "List contacts",
                "description": "List the people one of your vaults holds, narrowed and ordered the way the people screen narrows and orders them.\n\nThe default order is by name, not by when somebody was written down, so that a program and a person looking at the same vault are looking at the same list. The order always ends on the id, which is what stops a contact being skipped or repeated by a page boundary moving while you page through.\n\nThree groups of people are never in the list you asked for. Partial contacts, somebody mentioned in a relationship and reduced to a first name, are only in names-only until they are filled in. Archived contacts and deleted contacts are in none of them at all.\n\nA vault holding nobody answers with an empty list rather than an error.\n\nEach contact also carries columns: what the people screen of this vault shows beside the name, in its order, and the values each one holds for this person. A column holding several values, somebody with two email addresses, lists them all. A column holding nothing lists nothing. The values are written the way the screen writes them, dates included, and the raw dates stay in the attributes. The columns are the ones chosen with the endpoints below, or the defaults until somebody chooses.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the contact lives in, named either by the readable name it reports as slug or by its id. Both answer.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "filter": {
                                        "type": "string",
                                        "default": "all",
                                        "description": "Which people to list: all, favourites or names-only. Partial contacts are only in names-only, so all does not mean everybody the vault holds."
                                    },
                                    "query": {
                                        "type": "string",
                                        "description": "A search term, up to 255 characters. It is matched against the whole name, ignoring what the language of the account calls a minor difference, so elodie finds Élodie in French. It is also matched against the nickname as it was typed, ignoring case."
                                    },
                                    "sort": {
                                        "type": "string",
                                        "default": "name",
                                        "description": "Which order to answer in: name, nickname, last-spoke or added. A contact the order knows nothing about, somebody with no nickname when sorting by nickname, is at the end whichever direction is asked for."
                                    },
                                    "direction": {
                                        "type": "string",
                                        "default": "asc",
                                        "description": "Either asc or desc."
                                    },
                                    "page": {
                                        "type": "integer",
                                        "default": 1,
                                        "description": "Which page to answer with."
                                    },
                                    "per_page": {
                                        "type": "integer",
                                        "default": 25,
                                        "description": "How many contacts one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused."
                                    },
                                    "categories": {
                                        "type": "object",
                                        "items": {
                                            "type": "integer",
                                            "description": "Narrow the list to the people holding any of these categories, by the ids the list of categories below gives. It narrows together with the filter. An id that is not one of your contact categories answers 422."
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "A page of contact objects, and how many there are in all. A vault belonging to somebody else answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The contacts on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One contact.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always contact. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "slug": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The readable name the contact is addressed by, built from the whole name above and unique within the vault. It keeps the alphabet the name is written in, so a name in Japanese is addressed in Japanese, sent as its own characters or percent encoded. It is not stable: correcting the name rebuilds it and the previous one stops answering, which is why a stored reference should be the id. Nothing lets you choose or edit it."
                                                            },
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The name the contact is shown under: the formatted name of the way of writing it chosen for display, else its parts in the order it reads in. It is what the lists sort on, and it is built rather than stored, so it cannot be written directly."
                                                            },
                                                            "formatted_name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The full name exactly as written for the way of writing it chosen for display, or null when that way is only parts."
                                                            },
                                                            "name_representations": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "Every way the current name is written: in its own script, transliterated into another, or as it is pronounced, in the order the owner put them. Every one of them finds the contact in a search. Nothing is transliterated for you.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One way of writing the name.",
                                                                    "properties": {
                                                                        "id": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "format": "uuid",
                                                                            "description": "The id of this way of writing the name. Send it back to keep it when the list is replaced."
                                                                        },
                                                                        "kind": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "written for the name in a script of its own, transliteration for the name carried into another script, phonetic for how it is pronounced."
                                                                        },
                                                                        "language": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "A BCP 47 language tag such as ko or ja, or null."
                                                                        },
                                                                        "script": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "An ISO 15924 script code such as Hang, Hani or Latn, or null."
                                                                        },
                                                                        "phonetic_system": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "For a pronunciation, the system it is written in, as the vCard PHONETIC parameter names it: ipa, piny, x-romaji, x-rr, x-other, or a token a device sent. Null for any other kind."
                                                                        },
                                                                        "formatted_name": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The full name exactly as it should appear, up to 255 characters, or null to build it from the parts. Always null for a pronunciation, which is written in its parts."
                                                                        },
                                                                        "prefix": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "Up to 50 characters, or null."
                                                                        },
                                                                        "given_name": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "Up to 255 characters, or null."
                                                                        },
                                                                        "additional_name": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "Other given names, up to 255 characters, or null."
                                                                        },
                                                                        "family_name": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "Up to 255 characters, or null."
                                                                        },
                                                                        "suffix": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "Up to 50 characters, or null."
                                                                        },
                                                                        "name_order": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "Either given_first or family_first, or null to leave it to the reader."
                                                                        },
                                                                        "position": {
                                                                            "type": [
                                                                                "integer",
                                                                                "null"
                                                                            ],
                                                                            "description": "Where it stands in the list, from 1."
                                                                        },
                                                                        "is_display": {
                                                                            "type": [
                                                                                "boolean",
                                                                                "null"
                                                                            ],
                                                                            "description": "Whether this is the way the contact is shown under, in lists, titles, notifications and initials. Exactly one is, whenever the contact has a name."
                                                                        }
                                                                    }
                                                                }
                                                            },
                                                            "prefix": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What comes before the name, up to 50 characters, or null. Dr and Sir are prefixes."
                                                            },
                                                            "first_name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The given name of the way of writing the name chosen for display, up to 255 characters, or null. Like the prefix, the middle name, the last name, the suffix and the name order, it is a copy read from that way of writing it."
                                                            },
                                                            "middle_name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Up to 255 characters, or null."
                                                            },
                                                            "last_name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The family name, up to 255 characters, or null."
                                                            },
                                                            "suffix": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What comes after the name, up to 50 characters, or null. Jr and PhD are suffixes."
                                                            },
                                                            "maiden_name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Up to 255 characters, or null."
                                                            },
                                                            "nickname": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What this person is actually called, up to 255 characters, or null. It is searched as it was typed rather than folded, and it is what the whole name falls back to when no other part is set."
                                                            },
                                                            "name_order": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Either given_first or family_first, or null to leave it to the reader. It is a fact about this person rather than a preference of yours, which is what lets a Japanese name keep its order in a list of western ones."
                                                            },
                                                            "initials": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The one or two letters drawn when the contact has no picture. Built from the name, so it cannot be written."
                                                            },
                                                            "avatar_colour": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The background those initials are drawn on, as a hex colour. It is chosen when the contact is written down and never changes afterwards, so somebody who has learnt to spot a face in a list does not have it move."
                                                            },
                                                            "avatar": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The picture, or null when the contact is drawn as its initials.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the file the picture was stored as. It is a file of the vault like any other, so it counts against your storage."
                                                                    },
                                                                    "url": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Where the picture is served from. This address is served by the application and needs a signed in session rather than a token: no endpoint here streams a vault's files yet, and a document is as private as the record it sits on."
                                                                    }
                                                                }
                                                            },
                                                            "is_favourite": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the contact sits at the top of the list."
                                                            },
                                                            "is_archived": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the contact has been put away. An archived contact is left out of every list. Reading this is possible here; changing it is not, because no screen offers the gesture either."
                                                            },
                                                            "is_partial": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the contact is somebody mentioned in a relationship and reduced to a first name. A partial contact is off every list until somebody fills them in, so it is listed by no filter at all."
                                                            },
                                                            "is_me": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether this contact represents you. Exactly one contact per vault is, it cannot be deleted, and nothing here hands the title to somebody else."
                                                            },
                                                            "age": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How old the contact is in whole years, on your current day in your time zone. Null when the birthday is not recorded, when its year or its month is unknown, or when its date lies in the future. Null too when the birthday field is sensitive and the key lacks the sensitive-fields ability. It is worked out on every read and never stored."
                                                            },
                                                            "next_birthday_on": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The next birthday as a date written Y-m-d, on or after your current day in your time zone, so it is today's date on the birthday itself. A birthday on 29 February falls on 28 February in a year without one. Null when the birthday is not recorded, when its month is unknown, or when the birthday field is sensitive and the key lacks the sensitive-fields ability."
                                                            },
                                                            "structure_version_id": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "The published version of the template this contact renders from. It says what pages the contact has and what is written on them. Publishing a new version moves nobody: a contact stays on the version it points at until it is moved."
                                                            },
                                                            "template_name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What that template is called, which is what the lists show beside a contact."
                                                            },
                                                            "categories": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "The categories the contact holds, in the order of your list of contact categories. A category is a choice of that list held in any field of the template drawing on it. Empty when the contact holds none.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One category.",
                                                                    "properties": {
                                                                        "id": {
                                                                            "type": [
                                                                                "integer",
                                                                                "null"
                                                                            ],
                                                                            "description": "The id of the category, which is what the list of contacts filters on."
                                                                        },
                                                                        "label": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "What the category is called, in the language of the request for a category the application supplied."
                                                                        }
                                                                    }
                                                                }
                                                            },
                                                            "last_life_event_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the contact last took part in a life event, as a count of seconds since 1970, or null when they never have. It says nothing about whether you were there."
                                                            },
                                                            "last_interaction_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "The Last in touch date: the day of the latest life event the contact took part in that has already happened and whose nature has updates_last_in_touch, as a count of seconds since 1970, or null when there is none. This is what Last in touch and Last spoke read."
                                                            },
                                                            "last_consulted_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the contact was last consulted on their own, as a count of seconds since 1970, or null when they never have been: their page opened in Monica, the contact read through this endpoint, or read by an assistant connected over MCP. Listing contacts does not change it."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the contact was written down, as a count of seconds since 1970 rather than a written date."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the contact last changed, as a count of seconds. Equal to created_at until it first changes."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The page of the contact in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                            }
                                                        }
                                                    },
                                                    "columns": {
                                                        "type": [
                                                            "array",
                                                            "null"
                                                        ],
                                                        "description": "What the people screen of this vault shows beside the name, in its order. Hidden columns, and columns no template supplies any more, are left out.",
                                                        "items": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "One column.",
                                                            "properties": {
                                                                "source": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What the column shows, one of the sources the column endpoints below list."
                                                                },
                                                                "section": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "For a field of a template, the section holding it, or null."
                                                                },
                                                                "field_key": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "For a field of a template, its key inside the section, or null."
                                                                },
                                                                "values": {
                                                                    "type": [
                                                                        "array",
                                                                        "null"
                                                                    ],
                                                                    "description": "What this person holds in the column, written the way the screen writes it. Empty when they hold nothing.",
                                                                    "items": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "One value."
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "contact",
                                            "id": "c4a1f7b2-8e36-4d59-b0a7-2f5c9d81e364",
                                            "attributes": {
                                                "slug": "pam-beesly",
                                                "name": "Pam Beesly",
                                                "formatted_name": null,
                                                "name_representations": [
                                                    {
                                                        "id": "0e6d3b1a-52c7-4f9e-8a41-b7d2c96f0e13",
                                                        "kind": "written",
                                                        "language": null,
                                                        "script": null,
                                                        "phonetic_system": null,
                                                        "formatted_name": null,
                                                        "prefix": null,
                                                        "given_name": "Pam",
                                                        "additional_name": null,
                                                        "family_name": "Beesly",
                                                        "suffix": null,
                                                        "name_order": "given_first",
                                                        "position": 1,
                                                        "is_display": true
                                                    }
                                                ],
                                                "prefix": null,
                                                "first_name": "Pam",
                                                "middle_name": null,
                                                "last_name": "Beesly",
                                                "suffix": null,
                                                "maiden_name": null,
                                                "nickname": "Pammy",
                                                "name_order": "given_first",
                                                "initials": "PB",
                                                "avatar_colour": "#0ea5e9",
                                                "avatar": {
                                                    "id": "3f6c1d90-4b27-4e85-a1c3-9d720f5b8e46",
                                                    "url": "https://my.monicahq.com/api/v1/vaults/9d4f1c2e-7b3a-4f88-9a2d-6c1e5b0f7a31/files/3f6c1d90-4b27-4e85-a1c3-9d720f5b8e46"
                                                },
                                                "is_favourite": true,
                                                "is_archived": false,
                                                "is_partial": false,
                                                "is_me": false,
                                                "age": 36,
                                                "next_birthday_on": "2026-03-14",
                                                "structure_version_id": 4,
                                                "template_name": "Default contact",
                                                "categories": [
                                                    {
                                                        "id": 12,
                                                        "label": "Colleague"
                                                    }
                                                ],
                                                "last_life_event_at": null,
                                                "created_at": 1756252800,
                                                "last_interaction_at": null,
                                                "last_consulted_at": 1756339200,
                                                "updated_at": 1756339200
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/pam-beesly",
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/contacts/pam-beesly"
                                            },
                                            "columns": [
                                                {
                                                    "source": "email",
                                                    "section": null,
                                                    "field_key": null,
                                                    "values": [
                                                        "pam@dundermifflin.com",
                                                        "pambeesly@gmail.com"
                                                    ]
                                                },
                                                {
                                                    "source": "phone",
                                                    "section": null,
                                                    "field_key": null,
                                                    "values": [
                                                        "+1 570 555 0162 (Work)"
                                                    ]
                                                },
                                                {
                                                    "source": "last-spoke",
                                                    "section": null,
                                                    "field_key": null,
                                                    "values": []
                                                }
                                            ]
                                        },
                                        {
                                            "type": "contact",
                                            "id": "7b2e9034-5c18-4af6-9d21-0e83b6c47a5f",
                                            "attributes": {
                                                "slug": "dwight-kurt-schrute",
                                                "name": "Dwight Kurt Schrute",
                                                "formatted_name": null,
                                                "name_representations": [
                                                    {
                                                        "id": "9a27c5e1-3f84-4b6d-8e02-d1b7a4c96f38",
                                                        "kind": "written",
                                                        "language": null,
                                                        "script": null,
                                                        "phonetic_system": null,
                                                        "formatted_name": null,
                                                        "prefix": null,
                                                        "given_name": "Dwight",
                                                        "additional_name": "Kurt",
                                                        "family_name": "Schrute",
                                                        "suffix": null,
                                                        "name_order": null,
                                                        "position": 1,
                                                        "is_display": true
                                                    }
                                                ],
                                                "prefix": null,
                                                "first_name": "Dwight",
                                                "middle_name": "Kurt",
                                                "last_name": "Schrute",
                                                "suffix": null,
                                                "maiden_name": null,
                                                "nickname": null,
                                                "name_order": null,
                                                "initials": "DS",
                                                "avatar_colour": "#22c55e",
                                                "avatar": null,
                                                "is_favourite": false,
                                                "is_archived": false,
                                                "is_partial": false,
                                                "is_me": false,
                                                "age": null,
                                                "next_birthday_on": null,
                                                "structure_version_id": 4,
                                                "template_name": "Default contact",
                                                "categories": [],
                                                "last_life_event_at": 1756166400,
                                                "created_at": 1756080000,
                                                "last_interaction_at": 1756166400,
                                                "last_consulted_at": null,
                                                "updated_at": 1756080000
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/dwight-kurt-schrute",
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/contacts/dwight-kurt-schrute"
                                            },
                                            "columns": [
                                                {
                                                    "source": "email",
                                                    "section": null,
                                                    "field_key": null,
                                                    "values": [
                                                        "dwight@schrutefarms.com"
                                                    ]
                                                },
                                                {
                                                    "source": "phone",
                                                    "section": null,
                                                    "field_key": null,
                                                    "values": []
                                                },
                                                {
                                                    "source": "last-spoke",
                                                    "section": null,
                                                    "field_key": null,
                                                    "values": [
                                                        "3 weeks ago"
                                                    ]
                                                }
                                            ]
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 2
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "post": {
                "operationId": "contacts-create",
                "tags": [
                    "Contacts"
                ],
                "summary": "Create a contact",
                "description": "Write somebody down in one of your vaults.\n\nA first name is all this asks for. Everything else about a person can be filled in later, and a product that refuses to write down somebody you have only just met is one people work around.\n\nThe contact starts from the structure this vault publishes for contacts unless you name another. Whichever it is, the contact stays on that exact version until somebody moves it: publishing a new version of a template moves nobody.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the contact lives in, named either by the readable name it reports as slug or by its id. Both answer.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "first_name": {
                                        "type": "string",
                                        "description": "The given name, up to 255 characters. It is the only thing this asks for: somebody met once is worth writing down with nothing else."
                                    },
                                    "prefix": {
                                        "type": "string",
                                        "description": "What comes before the name, up to 50 characters."
                                    },
                                    "middle_name": {
                                        "type": "string",
                                        "description": "Up to 255 characters."
                                    },
                                    "last_name": {
                                        "type": "string",
                                        "description": "The family name, up to 255 characters."
                                    },
                                    "suffix": {
                                        "type": "string",
                                        "description": "What comes after the name, up to 50 characters."
                                    },
                                    "maiden_name": {
                                        "type": "string",
                                        "description": "Up to 255 characters."
                                    },
                                    "nickname": {
                                        "type": "string",
                                        "description": "What this person is actually called, up to 255 characters."
                                    },
                                    "name_order": {
                                        "type": "string",
                                        "description": "Either given_first or family_first. Left out, the reader decides."
                                    },
                                    "is_partial": {
                                        "type": "boolean",
                                        "description": "Whether this is somebody you know of rather than somebody you have written down. A partial contact is off every list until they are more than a first name. False when nothing says."
                                    },
                                    "is_favourite": {
                                        "type": "boolean",
                                        "description": "Whether the contact sits at the top of the list. False when nothing says."
                                    },
                                    "structure_version_id": {
                                        "type": "integer",
                                        "description": "The published version of one of your active contact templates, which says what the contact's page holds. Left out, the contact starts from whatever this vault publishes for contacts. A draft, a version belonging to somebody else, and a version describing something other than a contact are each refused."
                                    }
                                },
                                "required": [
                                    "first_name"
                                ]
                            },
                            "example": {
                                "first_name": "Pam",
                                "last_name": "Beesly"
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The contact object as it now reads, including the name assembled from the parts you sent. A vault belonging to somebody else answers 404 and nobody is written down.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The contact.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always contact. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "slug": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The readable name the contact is addressed by, built from the whole name above and unique within the vault. It keeps the alphabet the name is written in, so a name in Japanese is addressed in Japanese, sent as its own characters or percent encoded. It is not stable: correcting the name rebuilds it and the previous one stops answering, which is why a stored reference should be the id. Nothing lets you choose or edit it."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The name the contact is shown under: the formatted name of the way of writing it chosen for display, else its parts in the order it reads in. It is what the lists sort on, and it is built rather than stored, so it cannot be written directly."
                                                        },
                                                        "formatted_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The full name exactly as written for the way of writing it chosen for display, or null when that way is only parts."
                                                        },
                                                        "name_representations": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "Every way the current name is written: in its own script, transliterated into another, or as it is pronounced, in the order the owner put them. Every one of them finds the contact in a search. Nothing is transliterated for you.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One way of writing the name.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of this way of writing the name. Send it back to keep it when the list is replaced."
                                                                    },
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "written for the name in a script of its own, transliteration for the name carried into another script, phonetic for how it is pronounced."
                                                                    },
                                                                    "language": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "A BCP 47 language tag such as ko or ja, or null."
                                                                    },
                                                                    "script": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "An ISO 15924 script code such as Hang, Hani or Latn, or null."
                                                                    },
                                                                    "phonetic_system": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "For a pronunciation, the system it is written in, as the vCard PHONETIC parameter names it: ipa, piny, x-romaji, x-rr, x-other, or a token a device sent. Null for any other kind."
                                                                    },
                                                                    "formatted_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The full name exactly as it should appear, up to 255 characters, or null to build it from the parts. Always null for a pronunciation, which is written in its parts."
                                                                    },
                                                                    "prefix": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 50 characters, or null."
                                                                    },
                                                                    "given_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 255 characters, or null."
                                                                    },
                                                                    "additional_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Other given names, up to 255 characters, or null."
                                                                    },
                                                                    "family_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 255 characters, or null."
                                                                    },
                                                                    "suffix": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 50 characters, or null."
                                                                    },
                                                                    "name_order": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Either given_first or family_first, or null to leave it to the reader."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Where it stands in the list, from 1."
                                                                    },
                                                                    "is_display": {
                                                                        "type": [
                                                                            "boolean",
                                                                            "null"
                                                                        ],
                                                                        "description": "Whether this is the way the contact is shown under, in lists, titles, notifications and initials. Exactly one is, whenever the contact has a name."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "prefix": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What comes before the name, up to 50 characters, or null. Dr and Sir are prefixes."
                                                        },
                                                        "first_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The given name of the way of writing the name chosen for display, up to 255 characters, or null. Like the prefix, the middle name, the last name, the suffix and the name order, it is a copy read from that way of writing it."
                                                        },
                                                        "middle_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Up to 255 characters, or null."
                                                        },
                                                        "last_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The family name, up to 255 characters, or null."
                                                        },
                                                        "suffix": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What comes after the name, up to 50 characters, or null. Jr and PhD are suffixes."
                                                        },
                                                        "maiden_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Up to 255 characters, or null."
                                                        },
                                                        "nickname": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What this person is actually called, up to 255 characters, or null. It is searched as it was typed rather than folded, and it is what the whole name falls back to when no other part is set."
                                                        },
                                                        "name_order": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either given_first or family_first, or null to leave it to the reader. It is a fact about this person rather than a preference of yours, which is what lets a Japanese name keep its order in a list of western ones."
                                                        },
                                                        "initials": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The one or two letters drawn when the contact has no picture. Built from the name, so it cannot be written."
                                                        },
                                                        "avatar_colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The background those initials are drawn on, as a hex colour. It is chosen when the contact is written down and never changes afterwards, so somebody who has learnt to spot a face in a list does not have it move."
                                                        },
                                                        "avatar": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "Always null here. A contact is written down before it has a picture, and putting one on is its own call."
                                                        },
                                                        "is_favourite": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the contact sits at the top of the list."
                                                        },
                                                        "is_archived": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the contact has been put away. An archived contact is left out of every list. Reading this is possible here; changing it is not, because no screen offers the gesture either."
                                                        },
                                                        "is_partial": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the contact is somebody mentioned in a relationship and reduced to a first name. A partial contact is off every list until somebody fills them in, so it is listed by no filter at all."
                                                        },
                                                        "is_me": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether this contact represents you. Exactly one contact per vault is, it cannot be deleted, and nothing here hands the title to somebody else."
                                                        },
                                                        "age": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How old the contact is in whole years, on your current day in your time zone. Null when the birthday is not recorded, when its year or its month is unknown, or when its date lies in the future. Null too when the birthday field is sensitive and the key lacks the sensitive-fields ability. It is worked out on every read and never stored."
                                                        },
                                                        "next_birthday_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The next birthday as a date written Y-m-d, on or after your current day in your time zone, so it is today's date on the birthday itself. A birthday on 29 February falls on 28 February in a year without one. Null when the birthday is not recorded, when its month is unknown, or when the birthday field is sensitive and the key lacks the sensitive-fields ability."
                                                        },
                                                        "structure_version_id": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The published version of the template this contact renders from. It says what pages the contact has and what is written on them. Publishing a new version moves nobody: a contact stays on the version it points at until it is moved."
                                                        },
                                                        "template_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What that template is called, which is what the lists show beside a contact."
                                                        },
                                                        "categories": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "Always empty here. A contact is written down before it holds a category, and giving it one is saving a section of its page."
                                                        },
                                                        "last_life_event_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact last took part in a life event, as a count of seconds since 1970, or null when they never have. It says nothing about whether you were there."
                                                        },
                                                        "last_interaction_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The Last in touch date: the day of the latest life event the contact took part in that has already happened and whose nature has updates_last_in_touch, as a count of seconds since 1970, or null when there is none. This is what Last in touch and Last spoke read."
                                                        },
                                                        "last_consulted_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact was last consulted on their own, as a count of seconds since 1970, or null when they never have been: their page opened in Monica, the contact read through this endpoint, or read by an assistant connected over MCP. Listing contacts does not change it."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact was written down, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The page of the contact in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "contact",
                                        "id": "c4a1f7b2-8e36-4d59-b0a7-2f5c9d81e364",
                                        "attributes": {
                                            "slug": "pam-beesly",
                                            "name": "Pam Beesly",
                                            "formatted_name": null,
                                            "name_representations": [
                                                {
                                                    "id": "0e6d3b1a-52c7-4f9e-8a41-b7d2c96f0e13",
                                                    "kind": "written",
                                                    "language": null,
                                                    "script": null,
                                                    "phonetic_system": null,
                                                    "formatted_name": null,
                                                    "prefix": null,
                                                    "given_name": "Pam",
                                                    "additional_name": null,
                                                    "family_name": "Beesly",
                                                    "suffix": null,
                                                    "name_order": "given_first",
                                                    "position": 1,
                                                    "is_display": true
                                                }
                                            ],
                                            "prefix": null,
                                            "first_name": "Pam",
                                            "middle_name": null,
                                            "last_name": "Beesly",
                                            "suffix": null,
                                            "maiden_name": null,
                                            "nickname": "Pammy",
                                            "name_order": "given_first",
                                            "initials": "PB",
                                            "avatar_colour": "#0ea5e9",
                                            "avatar": null,
                                            "is_favourite": true,
                                            "is_archived": false,
                                            "is_partial": false,
                                            "is_me": false,
                                            "age": 36,
                                            "next_birthday_on": "2026-03-14",
                                            "structure_version_id": 4,
                                            "template_name": "Default contact",
                                            "categories": [],
                                            "last_life_event_at": null,
                                            "created_at": 1756252800,
                                            "last_interaction_at": null,
                                            "last_consulted_at": 1756339200,
                                            "updated_at": 1756252800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/pam-beesly",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/contacts/pam-beesly"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/contacts/{contact}": {
            "get": {
                "operationId": "contacts-show",
                "tags": [
                    "Contacts"
                ],
                "summary": "Get a contact",
                "description": "Retrieve one contact: their name, how they are drawn, and which structure their page renders from.\n\nWhat is actually written on the contact, the dates, the addresses and the notes their template asks for, is not in here. That comes from the template version named below and is a surface of its own, still to be built. This endpoint answers with the part of a contact the product imposes rather than the part you designed.\n\nReading a contact is not written to your account log, and it does not count as somebody having consulted the record.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the contact lives in, named either by the readable name it reports as slug or by its id. Both answer.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "contact",
                        "in": "path",
                        "required": true,
                        "description": "The contact, named either by the readable name it reports as slug or by its id. Both answer. A readable name is rebuilt whenever the record is renamed, and the previous one stops answering, so a client that stores a reference stores the id. A name a record has released is never given to another. The contact has to be in the vault the path names: a contact of yours addressed through the wrong vault answers 404, the same as one that never existed. A contact absorbed by a merge answers 404 here, and the merge endpoints say what became of them.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A contact object. A contact belonging to somebody else answers 404, which is also what a contact that never existed answers, what a deleted one answers, and what one of your own contacts answers when the vault in the path is not the one holding them.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The contact.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always contact. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "slug": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The readable name the contact is addressed by, built from the whole name above and unique within the vault. It keeps the alphabet the name is written in, so a name in Japanese is addressed in Japanese, sent as its own characters or percent encoded. It is not stable: correcting the name rebuilds it and the previous one stops answering, which is why a stored reference should be the id. Nothing lets you choose or edit it."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The name the contact is shown under: the formatted name of the way of writing it chosen for display, else its parts in the order it reads in. It is what the lists sort on, and it is built rather than stored, so it cannot be written directly."
                                                        },
                                                        "formatted_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The full name exactly as written for the way of writing it chosen for display, or null when that way is only parts."
                                                        },
                                                        "name_representations": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "Every way the current name is written: in its own script, transliterated into another, or as it is pronounced, in the order the owner put them. Every one of them finds the contact in a search. Nothing is transliterated for you.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One way of writing the name.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of this way of writing the name. Send it back to keep it when the list is replaced."
                                                                    },
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "written for the name in a script of its own, transliteration for the name carried into another script, phonetic for how it is pronounced."
                                                                    },
                                                                    "language": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "A BCP 47 language tag such as ko or ja, or null."
                                                                    },
                                                                    "script": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "An ISO 15924 script code such as Hang, Hani or Latn, or null."
                                                                    },
                                                                    "phonetic_system": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "For a pronunciation, the system it is written in, as the vCard PHONETIC parameter names it: ipa, piny, x-romaji, x-rr, x-other, or a token a device sent. Null for any other kind."
                                                                    },
                                                                    "formatted_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The full name exactly as it should appear, up to 255 characters, or null to build it from the parts. Always null for a pronunciation, which is written in its parts."
                                                                    },
                                                                    "prefix": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 50 characters, or null."
                                                                    },
                                                                    "given_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 255 characters, or null."
                                                                    },
                                                                    "additional_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Other given names, up to 255 characters, or null."
                                                                    },
                                                                    "family_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 255 characters, or null."
                                                                    },
                                                                    "suffix": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 50 characters, or null."
                                                                    },
                                                                    "name_order": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Either given_first or family_first, or null to leave it to the reader."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Where it stands in the list, from 1."
                                                                    },
                                                                    "is_display": {
                                                                        "type": [
                                                                            "boolean",
                                                                            "null"
                                                                        ],
                                                                        "description": "Whether this is the way the contact is shown under, in lists, titles, notifications and initials. Exactly one is, whenever the contact has a name."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "prefix": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What comes before the name, up to 50 characters, or null. Dr and Sir are prefixes."
                                                        },
                                                        "first_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The given name of the way of writing the name chosen for display, up to 255 characters, or null. Like the prefix, the middle name, the last name, the suffix and the name order, it is a copy read from that way of writing it."
                                                        },
                                                        "middle_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Up to 255 characters, or null."
                                                        },
                                                        "last_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The family name, up to 255 characters, or null."
                                                        },
                                                        "suffix": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What comes after the name, up to 50 characters, or null. Jr and PhD are suffixes."
                                                        },
                                                        "maiden_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Up to 255 characters, or null."
                                                        },
                                                        "nickname": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What this person is actually called, up to 255 characters, or null. It is searched as it was typed rather than folded, and it is what the whole name falls back to when no other part is set."
                                                        },
                                                        "name_order": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either given_first or family_first, or null to leave it to the reader. It is a fact about this person rather than a preference of yours, which is what lets a Japanese name keep its order in a list of western ones."
                                                        },
                                                        "initials": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The one or two letters drawn when the contact has no picture. Built from the name, so it cannot be written."
                                                        },
                                                        "avatar_colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The background those initials are drawn on, as a hex colour. It is chosen when the contact is written down and never changes afterwards, so somebody who has learnt to spot a face in a list does not have it move."
                                                        },
                                                        "avatar": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The picture, or null when the contact is drawn as its initials.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the file the picture was stored as. It is a file of the vault like any other, so it counts against your storage."
                                                                },
                                                                "url": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "Where the picture is served from. This address is served by the application and needs a signed in session rather than a token: no endpoint here streams a vault's files yet, and a document is as private as the record it sits on."
                                                                }
                                                            }
                                                        },
                                                        "is_favourite": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the contact sits at the top of the list."
                                                        },
                                                        "is_archived": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the contact has been put away. An archived contact is left out of every list. Reading this is possible here; changing it is not, because no screen offers the gesture either."
                                                        },
                                                        "is_partial": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the contact is somebody mentioned in a relationship and reduced to a first name. A partial contact is off every list until somebody fills them in, so it is listed by no filter at all."
                                                        },
                                                        "is_me": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether this contact represents you. Exactly one contact per vault is, it cannot be deleted, and nothing here hands the title to somebody else."
                                                        },
                                                        "age": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How old the contact is in whole years, on your current day in your time zone. Null when the birthday is not recorded, when its year or its month is unknown, or when its date lies in the future. Null too when the birthday field is sensitive and the key lacks the sensitive-fields ability. It is worked out on every read and never stored."
                                                        },
                                                        "next_birthday_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The next birthday as a date written Y-m-d, on or after your current day in your time zone, so it is today's date on the birthday itself. A birthday on 29 February falls on 28 February in a year without one. Null when the birthday is not recorded, when its month is unknown, or when the birthday field is sensitive and the key lacks the sensitive-fields ability."
                                                        },
                                                        "structure_version_id": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The published version of the template this contact renders from. It says what pages the contact has and what is written on them. Publishing a new version moves nobody: a contact stays on the version it points at until it is moved."
                                                        },
                                                        "template_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What that template is called, which is what the lists show beside a contact."
                                                        },
                                                        "categories": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The categories the contact holds, in the order of your list of contact categories. A category is a choice of that list held in any field of the template drawing on it. Empty when the contact holds none.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One category.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "The id of the category, which is what the list of contacts filters on."
                                                                    },
                                                                    "label": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the category is called, in the language of the request for a category the application supplied."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "last_life_event_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact last took part in a life event, as a count of seconds since 1970, or null when they never have. It says nothing about whether you were there."
                                                        },
                                                        "last_interaction_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The Last in touch date: the day of the latest life event the contact took part in that has already happened and whose nature has updates_last_in_touch, as a count of seconds since 1970, or null when there is none. This is what Last in touch and Last spoke read."
                                                        },
                                                        "last_consulted_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact was last consulted on their own, as a count of seconds since 1970, or null when they never have been: their page opened in Monica, the contact read through this endpoint, or read by an assistant connected over MCP. Listing contacts does not change it."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact was written down, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The page of the contact in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "contact",
                                        "id": "c4a1f7b2-8e36-4d59-b0a7-2f5c9d81e364",
                                        "attributes": {
                                            "slug": "pam-beesly",
                                            "name": "Pam Beesly",
                                            "formatted_name": null,
                                            "name_representations": [
                                                {
                                                    "id": "0e6d3b1a-52c7-4f9e-8a41-b7d2c96f0e13",
                                                    "kind": "written",
                                                    "language": null,
                                                    "script": null,
                                                    "phonetic_system": null,
                                                    "formatted_name": null,
                                                    "prefix": null,
                                                    "given_name": "Pam",
                                                    "additional_name": null,
                                                    "family_name": "Beesly",
                                                    "suffix": null,
                                                    "name_order": "given_first",
                                                    "position": 1,
                                                    "is_display": true
                                                }
                                            ],
                                            "prefix": null,
                                            "first_name": "Pam",
                                            "middle_name": null,
                                            "last_name": "Beesly",
                                            "suffix": null,
                                            "maiden_name": null,
                                            "nickname": "Pammy",
                                            "name_order": "given_first",
                                            "initials": "PB",
                                            "avatar_colour": "#0ea5e9",
                                            "avatar": {
                                                "id": "3f6c1d90-4b27-4e85-a1c3-9d720f5b8e46",
                                                "url": "https://my.monicahq.com/api/v1/vaults/9d4f1c2e-7b3a-4f88-9a2d-6c1e5b0f7a31/files/3f6c1d90-4b27-4e85-a1c3-9d720f5b8e46"
                                            },
                                            "is_favourite": true,
                                            "is_archived": false,
                                            "is_partial": false,
                                            "is_me": false,
                                            "age": 36,
                                            "next_birthday_on": "2026-03-14",
                                            "structure_version_id": 4,
                                            "template_name": "Default contact",
                                            "categories": [
                                                {
                                                    "id": 12,
                                                    "label": "Colleague"
                                                }
                                            ],
                                            "last_life_event_at": null,
                                            "created_at": 1756252800,
                                            "last_interaction_at": null,
                                            "last_consulted_at": 1756339200,
                                            "updated_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/pam-beesly",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/contacts/pam-beesly"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "contacts-show-query",
                "tags": [
                    "Contacts"
                ],
                "summary": "Get a contact",
                "description": "Retrieve one contact: their name, how they are drawn, and which structure their page renders from.\n\nWhat is actually written on the contact, the dates, the addresses and the notes their template asks for, is not in here. That comes from the template version named below and is a surface of its own, still to be built. This endpoint answers with the part of a contact the product imposes rather than the part you designed.\n\nReading a contact is not written to your account log, and it does not count as somebody having consulted the record.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the contact lives in, named either by the readable name it reports as slug or by its id. Both answer.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "contact",
                        "in": "path",
                        "required": true,
                        "description": "The contact, named either by the readable name it reports as slug or by its id. Both answer. A readable name is rebuilt whenever the record is renamed, and the previous one stops answering, so a client that stores a reference stores the id. A name a record has released is never given to another. The contact has to be in the vault the path names: a contact of yours addressed through the wrong vault answers 404, the same as one that never existed. A contact absorbed by a merge answers 404 here, and the merge endpoints say what became of them.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A contact object. A contact belonging to somebody else answers 404, which is also what a contact that never existed answers, what a deleted one answers, and what one of your own contacts answers when the vault in the path is not the one holding them.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The contact.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always contact. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "slug": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The readable name the contact is addressed by, built from the whole name above and unique within the vault. It keeps the alphabet the name is written in, so a name in Japanese is addressed in Japanese, sent as its own characters or percent encoded. It is not stable: correcting the name rebuilds it and the previous one stops answering, which is why a stored reference should be the id. Nothing lets you choose or edit it."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The name the contact is shown under: the formatted name of the way of writing it chosen for display, else its parts in the order it reads in. It is what the lists sort on, and it is built rather than stored, so it cannot be written directly."
                                                        },
                                                        "formatted_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The full name exactly as written for the way of writing it chosen for display, or null when that way is only parts."
                                                        },
                                                        "name_representations": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "Every way the current name is written: in its own script, transliterated into another, or as it is pronounced, in the order the owner put them. Every one of them finds the contact in a search. Nothing is transliterated for you.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One way of writing the name.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of this way of writing the name. Send it back to keep it when the list is replaced."
                                                                    },
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "written for the name in a script of its own, transliteration for the name carried into another script, phonetic for how it is pronounced."
                                                                    },
                                                                    "language": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "A BCP 47 language tag such as ko or ja, or null."
                                                                    },
                                                                    "script": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "An ISO 15924 script code such as Hang, Hani or Latn, or null."
                                                                    },
                                                                    "phonetic_system": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "For a pronunciation, the system it is written in, as the vCard PHONETIC parameter names it: ipa, piny, x-romaji, x-rr, x-other, or a token a device sent. Null for any other kind."
                                                                    },
                                                                    "formatted_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The full name exactly as it should appear, up to 255 characters, or null to build it from the parts. Always null for a pronunciation, which is written in its parts."
                                                                    },
                                                                    "prefix": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 50 characters, or null."
                                                                    },
                                                                    "given_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 255 characters, or null."
                                                                    },
                                                                    "additional_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Other given names, up to 255 characters, or null."
                                                                    },
                                                                    "family_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 255 characters, or null."
                                                                    },
                                                                    "suffix": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 50 characters, or null."
                                                                    },
                                                                    "name_order": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Either given_first or family_first, or null to leave it to the reader."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Where it stands in the list, from 1."
                                                                    },
                                                                    "is_display": {
                                                                        "type": [
                                                                            "boolean",
                                                                            "null"
                                                                        ],
                                                                        "description": "Whether this is the way the contact is shown under, in lists, titles, notifications and initials. Exactly one is, whenever the contact has a name."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "prefix": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What comes before the name, up to 50 characters, or null. Dr and Sir are prefixes."
                                                        },
                                                        "first_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The given name of the way of writing the name chosen for display, up to 255 characters, or null. Like the prefix, the middle name, the last name, the suffix and the name order, it is a copy read from that way of writing it."
                                                        },
                                                        "middle_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Up to 255 characters, or null."
                                                        },
                                                        "last_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The family name, up to 255 characters, or null."
                                                        },
                                                        "suffix": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What comes after the name, up to 50 characters, or null. Jr and PhD are suffixes."
                                                        },
                                                        "maiden_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Up to 255 characters, or null."
                                                        },
                                                        "nickname": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What this person is actually called, up to 255 characters, or null. It is searched as it was typed rather than folded, and it is what the whole name falls back to when no other part is set."
                                                        },
                                                        "name_order": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either given_first or family_first, or null to leave it to the reader. It is a fact about this person rather than a preference of yours, which is what lets a Japanese name keep its order in a list of western ones."
                                                        },
                                                        "initials": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The one or two letters drawn when the contact has no picture. Built from the name, so it cannot be written."
                                                        },
                                                        "avatar_colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The background those initials are drawn on, as a hex colour. It is chosen when the contact is written down and never changes afterwards, so somebody who has learnt to spot a face in a list does not have it move."
                                                        },
                                                        "avatar": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The picture, or null when the contact is drawn as its initials.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the file the picture was stored as. It is a file of the vault like any other, so it counts against your storage."
                                                                },
                                                                "url": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "Where the picture is served from. This address is served by the application and needs a signed in session rather than a token: no endpoint here streams a vault's files yet, and a document is as private as the record it sits on."
                                                                }
                                                            }
                                                        },
                                                        "is_favourite": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the contact sits at the top of the list."
                                                        },
                                                        "is_archived": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the contact has been put away. An archived contact is left out of every list. Reading this is possible here; changing it is not, because no screen offers the gesture either."
                                                        },
                                                        "is_partial": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the contact is somebody mentioned in a relationship and reduced to a first name. A partial contact is off every list until somebody fills them in, so it is listed by no filter at all."
                                                        },
                                                        "is_me": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether this contact represents you. Exactly one contact per vault is, it cannot be deleted, and nothing here hands the title to somebody else."
                                                        },
                                                        "age": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How old the contact is in whole years, on your current day in your time zone. Null when the birthday is not recorded, when its year or its month is unknown, or when its date lies in the future. Null too when the birthday field is sensitive and the key lacks the sensitive-fields ability. It is worked out on every read and never stored."
                                                        },
                                                        "next_birthday_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The next birthday as a date written Y-m-d, on or after your current day in your time zone, so it is today's date on the birthday itself. A birthday on 29 February falls on 28 February in a year without one. Null when the birthday is not recorded, when its month is unknown, or when the birthday field is sensitive and the key lacks the sensitive-fields ability."
                                                        },
                                                        "structure_version_id": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The published version of the template this contact renders from. It says what pages the contact has and what is written on them. Publishing a new version moves nobody: a contact stays on the version it points at until it is moved."
                                                        },
                                                        "template_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What that template is called, which is what the lists show beside a contact."
                                                        },
                                                        "categories": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The categories the contact holds, in the order of your list of contact categories. A category is a choice of that list held in any field of the template drawing on it. Empty when the contact holds none.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One category.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "The id of the category, which is what the list of contacts filters on."
                                                                    },
                                                                    "label": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the category is called, in the language of the request for a category the application supplied."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "last_life_event_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact last took part in a life event, as a count of seconds since 1970, or null when they never have. It says nothing about whether you were there."
                                                        },
                                                        "last_interaction_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The Last in touch date: the day of the latest life event the contact took part in that has already happened and whose nature has updates_last_in_touch, as a count of seconds since 1970, or null when there is none. This is what Last in touch and Last spoke read."
                                                        },
                                                        "last_consulted_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact was last consulted on their own, as a count of seconds since 1970, or null when they never have been: their page opened in Monica, the contact read through this endpoint, or read by an assistant connected over MCP. Listing contacts does not change it."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact was written down, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The page of the contact in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "contact",
                                        "id": "c4a1f7b2-8e36-4d59-b0a7-2f5c9d81e364",
                                        "attributes": {
                                            "slug": "pam-beesly",
                                            "name": "Pam Beesly",
                                            "formatted_name": null,
                                            "name_representations": [
                                                {
                                                    "id": "0e6d3b1a-52c7-4f9e-8a41-b7d2c96f0e13",
                                                    "kind": "written",
                                                    "language": null,
                                                    "script": null,
                                                    "phonetic_system": null,
                                                    "formatted_name": null,
                                                    "prefix": null,
                                                    "given_name": "Pam",
                                                    "additional_name": null,
                                                    "family_name": "Beesly",
                                                    "suffix": null,
                                                    "name_order": "given_first",
                                                    "position": 1,
                                                    "is_display": true
                                                }
                                            ],
                                            "prefix": null,
                                            "first_name": "Pam",
                                            "middle_name": null,
                                            "last_name": "Beesly",
                                            "suffix": null,
                                            "maiden_name": null,
                                            "nickname": "Pammy",
                                            "name_order": "given_first",
                                            "initials": "PB",
                                            "avatar_colour": "#0ea5e9",
                                            "avatar": {
                                                "id": "3f6c1d90-4b27-4e85-a1c3-9d720f5b8e46",
                                                "url": "https://my.monicahq.com/api/v1/vaults/9d4f1c2e-7b3a-4f88-9a2d-6c1e5b0f7a31/files/3f6c1d90-4b27-4e85-a1c3-9d720f5b8e46"
                                            },
                                            "is_favourite": true,
                                            "is_archived": false,
                                            "is_partial": false,
                                            "is_me": false,
                                            "age": 36,
                                            "next_birthday_on": "2026-03-14",
                                            "structure_version_id": 4,
                                            "template_name": "Default contact",
                                            "categories": [
                                                {
                                                    "id": 12,
                                                    "label": "Colleague"
                                                }
                                            ],
                                            "last_life_event_at": null,
                                            "created_at": 1756252800,
                                            "last_interaction_at": null,
                                            "last_consulted_at": 1756339200,
                                            "updated_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/pam-beesly",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/contacts/pam-beesly"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "delete": {
                "operationId": "contacts-destroy",
                "tags": [
                    "Contacts"
                ],
                "summary": "Delete a contact",
                "description": "Delete a contact, and keep everything they took part in.\n\nNothing the contact was part of is destroyed. Relationships, life events and files outlive them, because those describe things that happened rather than the row itself.\n\nThe reminders about this person go quiet and say why, rather than disappearing. Private links onto their page stop opening.\n\nThe contact representing you cannot be deleted, and asking answers 422. Relationships and life events are written from that contact's point of view, so a vault that lost it would be talking about nobody.\n\nThe deletion is soft, so nothing is destroyed, but no endpoint here brings a contact back today. Treat it as final.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the contact lives in, named either by the readable name it reports as slug or by its id. Both answer.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "contact",
                        "in": "path",
                        "required": true,
                        "description": "The contact, named either by the readable name it reports as slug or by its id. Both answer. A readable name is rebuilt whenever the record is renamed, and the previous one stops answering, so a client that stores a reference stores the id. A name a record has released is never given to another. The contact has to be in the vault the path names: a contact of yours addressed through the wrong vault answers 404, the same as one that never existed. A contact absorbed by a merge answers 404 here, and the merge endpoints say what became of them.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Nothing at all. A contact belonging to somebody else answers 404, and so does one you have already deleted, so calling this twice does not report a second deletion."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/contacts/{contact}/markdown": {
            "get": {
                "operationId": "contacts-markdown",
                "tags": [
                    "Contacts"
                ],
                "summary": "Get a contact as Markdown",
                "description": "Retrieve everything recorded about one contact as a single Markdown document, written to be read by a person or handed to an assistant.\n\nThe body is the document itself, not JSON, with a file name attached. It is the same text the contact page downloads and copies, so an integration and the interface never disagree.\n\nIt holds the name and the other ways it is written, every field value under the page and section it sits in, the relationships by category, the life events newest first, the groups, the active reminders and the loans. A part with nothing in it is left out. Headings and labels are written in the language of the account, and what you wrote stays as you wrote it.\n\nValues of fields marked sensitive are left out unless the token presented carries the sensitive fields scope. A token minted for everything does not reach them: that scope has to be asked for by name.\n\nEvery call is written to the account log, as an export of the contact.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the contact lives in, named either by the readable name it reports as slug or by its id. Both answer.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "contact",
                        "in": "path",
                        "required": true,
                        "description": "The contact, named either by the readable name it reports as slug or by its id. Both answer. A readable name is rebuilt whenever the record is renamed, and the previous one stops answering, so a client that stores a reference stores the id. A name a record has released is never given to another. The contact has to be in the vault the path names: a contact of yours addressed through the wrong vault answers 404, the same as one that never existed. A contact absorbed by a merge answers 404 here, and the merge endpoints say what became of them.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The document, as text. A contact belonging to somebody else answers 404, and so does one of your own addressed through the wrong vault.",
                        "content": {
                            "text/markdown": {
                                "schema": {
                                    "type": "string"
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "contacts-markdown-query",
                "tags": [
                    "Contacts"
                ],
                "summary": "Get a contact as Markdown",
                "description": "Retrieve everything recorded about one contact as a single Markdown document, written to be read by a person or handed to an assistant.\n\nThe body is the document itself, not JSON, with a file name attached. It is the same text the contact page downloads and copies, so an integration and the interface never disagree.\n\nIt holds the name and the other ways it is written, every field value under the page and section it sits in, the relationships by category, the life events newest first, the groups, the active reminders and the loans. A part with nothing in it is left out. Headings and labels are written in the language of the account, and what you wrote stays as you wrote it.\n\nValues of fields marked sensitive are left out unless the token presented carries the sensitive fields scope. A token minted for everything does not reach them: that scope has to be asked for by name.\n\nEvery call is written to the account log, as an export of the contact.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the contact lives in, named either by the readable name it reports as slug or by its id. Both answer.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "contact",
                        "in": "path",
                        "required": true,
                        "description": "The contact, named either by the readable name it reports as slug or by its id. Both answer. A readable name is rebuilt whenever the record is renamed, and the previous one stops answering, so a client that stores a reference stores the id. A name a record has released is never given to another. The contact has to be in the vault the path names: a contact of yours addressed through the wrong vault answers 404, the same as one that never existed. A contact absorbed by a merge answers 404 here, and the merge endpoints say what became of them.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The document, as text. A contact belonging to somebody else answers 404, and so does one of your own addressed through the wrong vault.",
                        "content": {
                            "text/markdown": {
                                "schema": {
                                    "type": "string"
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/contacts/me": {
            "get": {
                "operationId": "contacts-me",
                "tags": [
                    "Contacts"
                ],
                "summary": "Get the Me contact",
                "description": "Retrieve the contact that represents you in a vault, without knowing its id first.\n\nEvery vault holds exactly one of these, and it cannot be deleted or merged away, so this endpoint is stable in a way an id you stored last year is not. It is what an integration should resolve first when it needs to know who the account holder is.\n\nIt answers the ordinary contact object. There is nothing special about the record beyond the flag, and everything you can do to a contact you can do to this one, apart from removing it.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the contact lives in, named either by the readable name it reports as slug or by its id. Both answer.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A contact object. A vault belonging to somebody else answers 404, and so does a vault of your own that holds no Me contact yet.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The contact.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always contact. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "slug": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The readable name the contact is addressed by, built from the whole name above and unique within the vault. It keeps the alphabet the name is written in, so a name in Japanese is addressed in Japanese, sent as its own characters or percent encoded. It is not stable: correcting the name rebuilds it and the previous one stops answering, which is why a stored reference should be the id. Nothing lets you choose or edit it."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The name the contact is shown under: the formatted name of the way of writing it chosen for display, else its parts in the order it reads in. It is what the lists sort on, and it is built rather than stored, so it cannot be written directly."
                                                        },
                                                        "formatted_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The full name exactly as written for the way of writing it chosen for display, or null when that way is only parts."
                                                        },
                                                        "name_representations": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "Every way the current name is written: in its own script, transliterated into another, or as it is pronounced, in the order the owner put them. Every one of them finds the contact in a search. Nothing is transliterated for you.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One way of writing the name.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of this way of writing the name. Send it back to keep it when the list is replaced."
                                                                    },
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "written for the name in a script of its own, transliteration for the name carried into another script, phonetic for how it is pronounced."
                                                                    },
                                                                    "language": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "A BCP 47 language tag such as ko or ja, or null."
                                                                    },
                                                                    "script": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "An ISO 15924 script code such as Hang, Hani or Latn, or null."
                                                                    },
                                                                    "phonetic_system": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "For a pronunciation, the system it is written in, as the vCard PHONETIC parameter names it: ipa, piny, x-romaji, x-rr, x-other, or a token a device sent. Null for any other kind."
                                                                    },
                                                                    "formatted_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The full name exactly as it should appear, up to 255 characters, or null to build it from the parts. Always null for a pronunciation, which is written in its parts."
                                                                    },
                                                                    "prefix": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 50 characters, or null."
                                                                    },
                                                                    "given_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 255 characters, or null."
                                                                    },
                                                                    "additional_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Other given names, up to 255 characters, or null."
                                                                    },
                                                                    "family_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 255 characters, or null."
                                                                    },
                                                                    "suffix": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 50 characters, or null."
                                                                    },
                                                                    "name_order": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Either given_first or family_first, or null to leave it to the reader."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Where it stands in the list, from 1."
                                                                    },
                                                                    "is_display": {
                                                                        "type": [
                                                                            "boolean",
                                                                            "null"
                                                                        ],
                                                                        "description": "Whether this is the way the contact is shown under, in lists, titles, notifications and initials. Exactly one is, whenever the contact has a name."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "prefix": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What comes before the name, up to 50 characters, or null. Dr and Sir are prefixes."
                                                        },
                                                        "first_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The given name of the way of writing the name chosen for display, up to 255 characters, or null. Like the prefix, the middle name, the last name, the suffix and the name order, it is a copy read from that way of writing it."
                                                        },
                                                        "middle_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Up to 255 characters, or null."
                                                        },
                                                        "last_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The family name, up to 255 characters, or null."
                                                        },
                                                        "suffix": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What comes after the name, up to 50 characters, or null. Jr and PhD are suffixes."
                                                        },
                                                        "maiden_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Up to 255 characters, or null."
                                                        },
                                                        "nickname": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What this person is actually called, up to 255 characters, or null. It is searched as it was typed rather than folded, and it is what the whole name falls back to when no other part is set."
                                                        },
                                                        "name_order": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either given_first or family_first, or null to leave it to the reader. It is a fact about this person rather than a preference of yours, which is what lets a Japanese name keep its order in a list of western ones."
                                                        },
                                                        "initials": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The one or two letters drawn when the contact has no picture. Built from the name, so it cannot be written."
                                                        },
                                                        "avatar_colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The background those initials are drawn on, as a hex colour. It is chosen when the contact is written down and never changes afterwards, so somebody who has learnt to spot a face in a list does not have it move."
                                                        },
                                                        "avatar": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The picture, or null when the contact is drawn as its initials.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the file the picture was stored as. It is a file of the vault like any other, so it counts against your storage."
                                                                },
                                                                "url": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "Where the picture is served from. This address is served by the application and needs a signed in session rather than a token: no endpoint here streams a vault's files yet, and a document is as private as the record it sits on."
                                                                }
                                                            }
                                                        },
                                                        "is_favourite": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the contact sits at the top of the list."
                                                        },
                                                        "is_archived": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the contact has been put away. An archived contact is left out of every list. Reading this is possible here; changing it is not, because no screen offers the gesture either."
                                                        },
                                                        "is_partial": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the contact is somebody mentioned in a relationship and reduced to a first name. A partial contact is off every list until somebody fills them in, so it is listed by no filter at all."
                                                        },
                                                        "is_me": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether this contact represents you. Exactly one contact per vault is, it cannot be deleted, and nothing here hands the title to somebody else."
                                                        },
                                                        "age": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How old the contact is in whole years, on your current day in your time zone. Null when the birthday is not recorded, when its year or its month is unknown, or when its date lies in the future. Null too when the birthday field is sensitive and the key lacks the sensitive-fields ability. It is worked out on every read and never stored."
                                                        },
                                                        "next_birthday_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The next birthday as a date written Y-m-d, on or after your current day in your time zone, so it is today's date on the birthday itself. A birthday on 29 February falls on 28 February in a year without one. Null when the birthday is not recorded, when its month is unknown, or when the birthday field is sensitive and the key lacks the sensitive-fields ability."
                                                        },
                                                        "structure_version_id": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The published version of the template this contact renders from. It says what pages the contact has and what is written on them. Publishing a new version moves nobody: a contact stays on the version it points at until it is moved."
                                                        },
                                                        "template_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What that template is called, which is what the lists show beside a contact."
                                                        },
                                                        "categories": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The categories the contact holds, in the order of your list of contact categories. A category is a choice of that list held in any field of the template drawing on it. Empty when the contact holds none.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One category.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "The id of the category, which is what the list of contacts filters on."
                                                                    },
                                                                    "label": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the category is called, in the language of the request for a category the application supplied."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "last_life_event_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact last took part in a life event, as a count of seconds since 1970, or null when they never have. It says nothing about whether you were there."
                                                        },
                                                        "last_interaction_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The Last in touch date: the day of the latest life event the contact took part in that has already happened and whose nature has updates_last_in_touch, as a count of seconds since 1970, or null when there is none. This is what Last in touch and Last spoke read."
                                                        },
                                                        "last_consulted_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact was last consulted on their own, as a count of seconds since 1970, or null when they never have been: their page opened in Monica, the contact read through this endpoint, or read by an assistant connected over MCP. Listing contacts does not change it."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact was written down, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The page of the contact in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "contact",
                                        "id": "c4a1f7b2-8e36-4d59-b0a7-2f5c9d81e364",
                                        "attributes": {
                                            "slug": "pam-beesly",
                                            "name": "Pam Beesly",
                                            "formatted_name": null,
                                            "name_representations": [
                                                {
                                                    "id": "0e6d3b1a-52c7-4f9e-8a41-b7d2c96f0e13",
                                                    "kind": "written",
                                                    "language": null,
                                                    "script": null,
                                                    "phonetic_system": null,
                                                    "formatted_name": null,
                                                    "prefix": null,
                                                    "given_name": "Pam",
                                                    "additional_name": null,
                                                    "family_name": "Beesly",
                                                    "suffix": null,
                                                    "name_order": "given_first",
                                                    "position": 1,
                                                    "is_display": true
                                                }
                                            ],
                                            "prefix": null,
                                            "first_name": "Pam",
                                            "middle_name": null,
                                            "last_name": "Beesly",
                                            "suffix": null,
                                            "maiden_name": null,
                                            "nickname": "Pammy",
                                            "name_order": "given_first",
                                            "initials": "PB",
                                            "avatar_colour": "#0ea5e9",
                                            "avatar": {
                                                "id": "3f6c1d90-4b27-4e85-a1c3-9d720f5b8e46",
                                                "url": "https://my.monicahq.com/api/v1/vaults/9d4f1c2e-7b3a-4f88-9a2d-6c1e5b0f7a31/files/3f6c1d90-4b27-4e85-a1c3-9d720f5b8e46"
                                            },
                                            "is_favourite": true,
                                            "is_archived": false,
                                            "is_partial": false,
                                            "is_me": false,
                                            "age": 36,
                                            "next_birthday_on": "2026-03-14",
                                            "structure_version_id": 4,
                                            "template_name": "Default contact",
                                            "categories": [
                                                {
                                                    "id": 12,
                                                    "label": "Colleague"
                                                }
                                            ],
                                            "last_life_event_at": null,
                                            "created_at": 1756252800,
                                            "last_interaction_at": null,
                                            "last_consulted_at": 1756339200,
                                            "updated_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/pam-beesly",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/contacts/pam-beesly"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "contacts-me-query",
                "tags": [
                    "Contacts"
                ],
                "summary": "Get the Me contact",
                "description": "Retrieve the contact that represents you in a vault, without knowing its id first.\n\nEvery vault holds exactly one of these, and it cannot be deleted or merged away, so this endpoint is stable in a way an id you stored last year is not. It is what an integration should resolve first when it needs to know who the account holder is.\n\nIt answers the ordinary contact object. There is nothing special about the record beyond the flag, and everything you can do to a contact you can do to this one, apart from removing it.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the contact lives in, named either by the readable name it reports as slug or by its id. Both answer.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A contact object. A vault belonging to somebody else answers 404, and so does a vault of your own that holds no Me contact yet.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The contact.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always contact. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "slug": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The readable name the contact is addressed by, built from the whole name above and unique within the vault. It keeps the alphabet the name is written in, so a name in Japanese is addressed in Japanese, sent as its own characters or percent encoded. It is not stable: correcting the name rebuilds it and the previous one stops answering, which is why a stored reference should be the id. Nothing lets you choose or edit it."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The name the contact is shown under: the formatted name of the way of writing it chosen for display, else its parts in the order it reads in. It is what the lists sort on, and it is built rather than stored, so it cannot be written directly."
                                                        },
                                                        "formatted_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The full name exactly as written for the way of writing it chosen for display, or null when that way is only parts."
                                                        },
                                                        "name_representations": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "Every way the current name is written: in its own script, transliterated into another, or as it is pronounced, in the order the owner put them. Every one of them finds the contact in a search. Nothing is transliterated for you.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One way of writing the name.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of this way of writing the name. Send it back to keep it when the list is replaced."
                                                                    },
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "written for the name in a script of its own, transliteration for the name carried into another script, phonetic for how it is pronounced."
                                                                    },
                                                                    "language": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "A BCP 47 language tag such as ko or ja, or null."
                                                                    },
                                                                    "script": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "An ISO 15924 script code such as Hang, Hani or Latn, or null."
                                                                    },
                                                                    "phonetic_system": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "For a pronunciation, the system it is written in, as the vCard PHONETIC parameter names it: ipa, piny, x-romaji, x-rr, x-other, or a token a device sent. Null for any other kind."
                                                                    },
                                                                    "formatted_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The full name exactly as it should appear, up to 255 characters, or null to build it from the parts. Always null for a pronunciation, which is written in its parts."
                                                                    },
                                                                    "prefix": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 50 characters, or null."
                                                                    },
                                                                    "given_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 255 characters, or null."
                                                                    },
                                                                    "additional_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Other given names, up to 255 characters, or null."
                                                                    },
                                                                    "family_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 255 characters, or null."
                                                                    },
                                                                    "suffix": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 50 characters, or null."
                                                                    },
                                                                    "name_order": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Either given_first or family_first, or null to leave it to the reader."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Where it stands in the list, from 1."
                                                                    },
                                                                    "is_display": {
                                                                        "type": [
                                                                            "boolean",
                                                                            "null"
                                                                        ],
                                                                        "description": "Whether this is the way the contact is shown under, in lists, titles, notifications and initials. Exactly one is, whenever the contact has a name."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "prefix": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What comes before the name, up to 50 characters, or null. Dr and Sir are prefixes."
                                                        },
                                                        "first_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The given name of the way of writing the name chosen for display, up to 255 characters, or null. Like the prefix, the middle name, the last name, the suffix and the name order, it is a copy read from that way of writing it."
                                                        },
                                                        "middle_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Up to 255 characters, or null."
                                                        },
                                                        "last_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The family name, up to 255 characters, or null."
                                                        },
                                                        "suffix": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What comes after the name, up to 50 characters, or null. Jr and PhD are suffixes."
                                                        },
                                                        "maiden_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Up to 255 characters, or null."
                                                        },
                                                        "nickname": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What this person is actually called, up to 255 characters, or null. It is searched as it was typed rather than folded, and it is what the whole name falls back to when no other part is set."
                                                        },
                                                        "name_order": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either given_first or family_first, or null to leave it to the reader. It is a fact about this person rather than a preference of yours, which is what lets a Japanese name keep its order in a list of western ones."
                                                        },
                                                        "initials": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The one or two letters drawn when the contact has no picture. Built from the name, so it cannot be written."
                                                        },
                                                        "avatar_colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The background those initials are drawn on, as a hex colour. It is chosen when the contact is written down and never changes afterwards, so somebody who has learnt to spot a face in a list does not have it move."
                                                        },
                                                        "avatar": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The picture, or null when the contact is drawn as its initials.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the file the picture was stored as. It is a file of the vault like any other, so it counts against your storage."
                                                                },
                                                                "url": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "Where the picture is served from. This address is served by the application and needs a signed in session rather than a token: no endpoint here streams a vault's files yet, and a document is as private as the record it sits on."
                                                                }
                                                            }
                                                        },
                                                        "is_favourite": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the contact sits at the top of the list."
                                                        },
                                                        "is_archived": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the contact has been put away. An archived contact is left out of every list. Reading this is possible here; changing it is not, because no screen offers the gesture either."
                                                        },
                                                        "is_partial": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the contact is somebody mentioned in a relationship and reduced to a first name. A partial contact is off every list until somebody fills them in, so it is listed by no filter at all."
                                                        },
                                                        "is_me": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether this contact represents you. Exactly one contact per vault is, it cannot be deleted, and nothing here hands the title to somebody else."
                                                        },
                                                        "age": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How old the contact is in whole years, on your current day in your time zone. Null when the birthday is not recorded, when its year or its month is unknown, or when its date lies in the future. Null too when the birthday field is sensitive and the key lacks the sensitive-fields ability. It is worked out on every read and never stored."
                                                        },
                                                        "next_birthday_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The next birthday as a date written Y-m-d, on or after your current day in your time zone, so it is today's date on the birthday itself. A birthday on 29 February falls on 28 February in a year without one. Null when the birthday is not recorded, when its month is unknown, or when the birthday field is sensitive and the key lacks the sensitive-fields ability."
                                                        },
                                                        "structure_version_id": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The published version of the template this contact renders from. It says what pages the contact has and what is written on them. Publishing a new version moves nobody: a contact stays on the version it points at until it is moved."
                                                        },
                                                        "template_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What that template is called, which is what the lists show beside a contact."
                                                        },
                                                        "categories": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The categories the contact holds, in the order of your list of contact categories. A category is a choice of that list held in any field of the template drawing on it. Empty when the contact holds none.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One category.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "The id of the category, which is what the list of contacts filters on."
                                                                    },
                                                                    "label": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the category is called, in the language of the request for a category the application supplied."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "last_life_event_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact last took part in a life event, as a count of seconds since 1970, or null when they never have. It says nothing about whether you were there."
                                                        },
                                                        "last_interaction_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The Last in touch date: the day of the latest life event the contact took part in that has already happened and whose nature has updates_last_in_touch, as a count of seconds since 1970, or null when there is none. This is what Last in touch and Last spoke read."
                                                        },
                                                        "last_consulted_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact was last consulted on their own, as a count of seconds since 1970, or null when they never have been: their page opened in Monica, the contact read through this endpoint, or read by an assistant connected over MCP. Listing contacts does not change it."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact was written down, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The page of the contact in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "contact",
                                        "id": "c4a1f7b2-8e36-4d59-b0a7-2f5c9d81e364",
                                        "attributes": {
                                            "slug": "pam-beesly",
                                            "name": "Pam Beesly",
                                            "formatted_name": null,
                                            "name_representations": [
                                                {
                                                    "id": "0e6d3b1a-52c7-4f9e-8a41-b7d2c96f0e13",
                                                    "kind": "written",
                                                    "language": null,
                                                    "script": null,
                                                    "phonetic_system": null,
                                                    "formatted_name": null,
                                                    "prefix": null,
                                                    "given_name": "Pam",
                                                    "additional_name": null,
                                                    "family_name": "Beesly",
                                                    "suffix": null,
                                                    "name_order": "given_first",
                                                    "position": 1,
                                                    "is_display": true
                                                }
                                            ],
                                            "prefix": null,
                                            "first_name": "Pam",
                                            "middle_name": null,
                                            "last_name": "Beesly",
                                            "suffix": null,
                                            "maiden_name": null,
                                            "nickname": "Pammy",
                                            "name_order": "given_first",
                                            "initials": "PB",
                                            "avatar_colour": "#0ea5e9",
                                            "avatar": {
                                                "id": "3f6c1d90-4b27-4e85-a1c3-9d720f5b8e46",
                                                "url": "https://my.monicahq.com/api/v1/vaults/9d4f1c2e-7b3a-4f88-9a2d-6c1e5b0f7a31/files/3f6c1d90-4b27-4e85-a1c3-9d720f5b8e46"
                                            },
                                            "is_favourite": true,
                                            "is_archived": false,
                                            "is_partial": false,
                                            "is_me": false,
                                            "age": 36,
                                            "next_birthday_on": "2026-03-14",
                                            "structure_version_id": 4,
                                            "template_name": "Default contact",
                                            "categories": [
                                                {
                                                    "id": 12,
                                                    "label": "Colleague"
                                                }
                                            ],
                                            "last_life_event_at": null,
                                            "created_at": 1756252800,
                                            "last_interaction_at": null,
                                            "last_consulted_at": 1756339200,
                                            "updated_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/pam-beesly",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/contacts/pam-beesly"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/contacts/{contact}/name": {
            "put": {
                "operationId": "contacts-name-update",
                "tags": [
                    "Contacts"
                ],
                "summary": "Change a name",
                "description": "Change the parts of the name a contact is shown under.\n\nIt changes the way of writing the name chosen for display, and leaves every other way alone. A contact with none is given one. To change the others, or which one is shown, replace the list of ways below.\n\nSend only the parts that change. A part left out keeps its value, and a part sent as null is cleared, so a request carrying nothing but a new last name changes the last name alone.\n\nEvery part may be null, including all of them together. A contact with no name still sorts, still searches and still draws initials: the product falls back to whatever it has rather than refusing you.\n\nWhat the lists sort and search on is rebuilt from the new name as it is written, in the language of your account, so the contact moves to its new place in the list at once.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the contact lives in, named either by the readable name it reports as slug or by its id. Both answer.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "contact",
                        "in": "path",
                        "required": true,
                        "description": "The contact, named either by the readable name it reports as slug or by its id. Both answer. A readable name is rebuilt whenever the record is renamed, and the previous one stops answering, so a client that stores a reference stores the id. A name a record has released is never given to another. The contact has to be in the vault the path names: a contact of yours addressed through the wrong vault answers 404, the same as one that never existed. A contact absorbed by a merge answers 404 here, and the merge endpoints say what became of them.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "prefix": {
                                        "type": "string",
                                        "description": "What comes before the name, up to 50 characters, or null."
                                    },
                                    "first_name": {
                                        "type": "string",
                                        "description": "The given name, up to 255 characters, or null. Unlike creating a contact, this may be null: a contact already written down may be reduced to a nickname."
                                    },
                                    "middle_name": {
                                        "type": "string",
                                        "description": "Up to 255 characters, or null."
                                    },
                                    "last_name": {
                                        "type": "string",
                                        "description": "The family name, up to 255 characters, or null."
                                    },
                                    "suffix": {
                                        "type": "string",
                                        "description": "What comes after the name, up to 50 characters, or null."
                                    },
                                    "maiden_name": {
                                        "type": "string",
                                        "description": "Up to 255 characters, or null."
                                    },
                                    "nickname": {
                                        "type": "string",
                                        "description": "Up to 255 characters, or null."
                                    },
                                    "name_order": {
                                        "type": "string",
                                        "description": "Either given_first or family_first, or null to leave it to the reader."
                                    }
                                }
                            },
                            "example": {
                                "first_name": "Pam",
                                "last_name": "Halpert",
                                "maiden_name": "Beesly",
                                "nickname": "Pammy",
                                "name_order": "given_first"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The contact object as it now reads. A contact belonging to somebody else, or reached through the wrong vault, answers 404 and is left as it was.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The contact.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always contact. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "slug": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The readable name the contact is addressed by, built from the whole name above and unique within the vault. It keeps the alphabet the name is written in, so a name in Japanese is addressed in Japanese, sent as its own characters or percent encoded. It is not stable: correcting the name rebuilds it and the previous one stops answering, which is why a stored reference should be the id. Nothing lets you choose or edit it."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The name the contact is shown under: the formatted name of the way of writing it chosen for display, else its parts in the order it reads in. It is what the lists sort on, and it is built rather than stored, so it cannot be written directly."
                                                        },
                                                        "formatted_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The full name exactly as written for the way of writing it chosen for display, or null when that way is only parts."
                                                        },
                                                        "name_representations": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "Every way the current name is written: in its own script, transliterated into another, or as it is pronounced, in the order the owner put them. Every one of them finds the contact in a search. Nothing is transliterated for you.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One way of writing the name.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of this way of writing the name. Send it back to keep it when the list is replaced."
                                                                    },
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "written for the name in a script of its own, transliteration for the name carried into another script, phonetic for how it is pronounced."
                                                                    },
                                                                    "language": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "A BCP 47 language tag such as ko or ja, or null."
                                                                    },
                                                                    "script": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "An ISO 15924 script code such as Hang, Hani or Latn, or null."
                                                                    },
                                                                    "phonetic_system": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "For a pronunciation, the system it is written in, as the vCard PHONETIC parameter names it: ipa, piny, x-romaji, x-rr, x-other, or a token a device sent. Null for any other kind."
                                                                    },
                                                                    "formatted_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The full name exactly as it should appear, up to 255 characters, or null to build it from the parts. Always null for a pronunciation, which is written in its parts."
                                                                    },
                                                                    "prefix": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 50 characters, or null."
                                                                    },
                                                                    "given_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 255 characters, or null."
                                                                    },
                                                                    "additional_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Other given names, up to 255 characters, or null."
                                                                    },
                                                                    "family_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 255 characters, or null."
                                                                    },
                                                                    "suffix": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 50 characters, or null."
                                                                    },
                                                                    "name_order": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Either given_first or family_first, or null to leave it to the reader."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Where it stands in the list, from 1."
                                                                    },
                                                                    "is_display": {
                                                                        "type": [
                                                                            "boolean",
                                                                            "null"
                                                                        ],
                                                                        "description": "Whether this is the way the contact is shown under, in lists, titles, notifications and initials. Exactly one is, whenever the contact has a name."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "prefix": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What comes before the name, up to 50 characters, or null. Dr and Sir are prefixes."
                                                        },
                                                        "first_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The given name of the way of writing the name chosen for display, up to 255 characters, or null. Like the prefix, the middle name, the last name, the suffix and the name order, it is a copy read from that way of writing it."
                                                        },
                                                        "middle_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Up to 255 characters, or null."
                                                        },
                                                        "last_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The family name, up to 255 characters, or null."
                                                        },
                                                        "suffix": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What comes after the name, up to 50 characters, or null. Jr and PhD are suffixes."
                                                        },
                                                        "maiden_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Up to 255 characters, or null."
                                                        },
                                                        "nickname": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What this person is actually called, up to 255 characters, or null. It is searched as it was typed rather than folded, and it is what the whole name falls back to when no other part is set."
                                                        },
                                                        "name_order": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either given_first or family_first, or null to leave it to the reader. It is a fact about this person rather than a preference of yours, which is what lets a Japanese name keep its order in a list of western ones."
                                                        },
                                                        "initials": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The one or two letters drawn when the contact has no picture. Built from the name, so it cannot be written."
                                                        },
                                                        "avatar_colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The background those initials are drawn on, as a hex colour. It is chosen when the contact is written down and never changes afterwards, so somebody who has learnt to spot a face in a list does not have it move."
                                                        },
                                                        "avatar": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The picture, or null when the contact is drawn as its initials.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the file the picture was stored as. It is a file of the vault like any other, so it counts against your storage."
                                                                },
                                                                "url": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "Where the picture is served from. This address is served by the application and needs a signed in session rather than a token: no endpoint here streams a vault's files yet, and a document is as private as the record it sits on."
                                                                }
                                                            }
                                                        },
                                                        "is_favourite": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the contact sits at the top of the list."
                                                        },
                                                        "is_archived": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the contact has been put away. An archived contact is left out of every list. Reading this is possible here; changing it is not, because no screen offers the gesture either."
                                                        },
                                                        "is_partial": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the contact is somebody mentioned in a relationship and reduced to a first name. A partial contact is off every list until somebody fills them in, so it is listed by no filter at all."
                                                        },
                                                        "is_me": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether this contact represents you. Exactly one contact per vault is, it cannot be deleted, and nothing here hands the title to somebody else."
                                                        },
                                                        "age": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How old the contact is in whole years, on your current day in your time zone. Null when the birthday is not recorded, when its year or its month is unknown, or when its date lies in the future. Null too when the birthday field is sensitive and the key lacks the sensitive-fields ability. It is worked out on every read and never stored."
                                                        },
                                                        "next_birthday_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The next birthday as a date written Y-m-d, on or after your current day in your time zone, so it is today's date on the birthday itself. A birthday on 29 February falls on 28 February in a year without one. Null when the birthday is not recorded, when its month is unknown, or when the birthday field is sensitive and the key lacks the sensitive-fields ability."
                                                        },
                                                        "structure_version_id": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The published version of the template this contact renders from. It says what pages the contact has and what is written on them. Publishing a new version moves nobody: a contact stays on the version it points at until it is moved."
                                                        },
                                                        "template_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What that template is called, which is what the lists show beside a contact."
                                                        },
                                                        "categories": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The categories the contact holds, in the order of your list of contact categories. A category is a choice of that list held in any field of the template drawing on it. Empty when the contact holds none.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One category.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "The id of the category, which is what the list of contacts filters on."
                                                                    },
                                                                    "label": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the category is called, in the language of the request for a category the application supplied."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "last_life_event_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact last took part in a life event, as a count of seconds since 1970, or null when they never have. It says nothing about whether you were there."
                                                        },
                                                        "last_interaction_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The Last in touch date: the day of the latest life event the contact took part in that has already happened and whose nature has updates_last_in_touch, as a count of seconds since 1970, or null when there is none. This is what Last in touch and Last spoke read."
                                                        },
                                                        "last_consulted_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact was last consulted on their own, as a count of seconds since 1970, or null when they never have been: their page opened in Monica, the contact read through this endpoint, or read by an assistant connected over MCP. Listing contacts does not change it."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact was written down, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The page of the contact in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "contact",
                                        "id": "c4a1f7b2-8e36-4d59-b0a7-2f5c9d81e364",
                                        "attributes": {
                                            "slug": "pam-beesly",
                                            "name": "Pam Beesly",
                                            "formatted_name": null,
                                            "name_representations": [
                                                {
                                                    "id": "0e6d3b1a-52c7-4f9e-8a41-b7d2c96f0e13",
                                                    "kind": "written",
                                                    "language": null,
                                                    "script": null,
                                                    "phonetic_system": null,
                                                    "formatted_name": null,
                                                    "prefix": null,
                                                    "given_name": "Pam",
                                                    "additional_name": null,
                                                    "family_name": "Beesly",
                                                    "suffix": null,
                                                    "name_order": "given_first",
                                                    "position": 1,
                                                    "is_display": true
                                                }
                                            ],
                                            "prefix": null,
                                            "first_name": "Pam",
                                            "middle_name": null,
                                            "last_name": "Beesly",
                                            "suffix": null,
                                            "maiden_name": null,
                                            "nickname": "Pammy",
                                            "name_order": "given_first",
                                            "initials": "PB",
                                            "avatar_colour": "#0ea5e9",
                                            "avatar": {
                                                "id": "3f6c1d90-4b27-4e85-a1c3-9d720f5b8e46",
                                                "url": "https://my.monicahq.com/api/v1/vaults/9d4f1c2e-7b3a-4f88-9a2d-6c1e5b0f7a31/files/3f6c1d90-4b27-4e85-a1c3-9d720f5b8e46"
                                            },
                                            "is_favourite": true,
                                            "is_archived": false,
                                            "is_partial": false,
                                            "is_me": false,
                                            "age": 36,
                                            "next_birthday_on": "2026-03-14",
                                            "structure_version_id": 4,
                                            "template_name": "Default contact",
                                            "categories": [
                                                {
                                                    "id": 12,
                                                    "label": "Colleague"
                                                }
                                            ],
                                            "last_life_event_at": null,
                                            "created_at": 1756252800,
                                            "last_interaction_at": null,
                                            "last_consulted_at": 1756339200,
                                            "updated_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/pam-beesly",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/contacts/pam-beesly"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/contacts/{contact}/name-representations": {
            "get": {
                "operationId": "contacts-name-representations-index",
                "tags": [
                    "Contacts"
                ],
                "summary": "List the ways a name is written",
                "description": "Retrieve every way the current name of a contact is written, and which one it is shown under.\n\n김민지, Kim Min-ji and 金敏智 are three ways of writing one name, not three names. Former names and nicknames are not here.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the contact lives in, named either by the readable name it reports as slug or by its id. Both answer.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "contact",
                        "in": "path",
                        "required": true,
                        "description": "The contact, named either by the readable name it reports as slug or by its id. Both answer. A readable name is rebuilt whenever the record is renamed, and the previous one stops answering, so a client that stores a reference stores the id. A name a record has released is never given to another. The contact has to be in the vault the path names: a contact of yours addressed through the wrong vault answers 404, the same as one that never existed. A contact absorbed by a merge answers 404 here, and the merge endpoints say what became of them.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The list, possibly empty. A contact belonging to somebody else, or reached through the wrong vault, answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "Every way the name is written, in order.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One way of writing the name.",
                                                "properties": {
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "format": "uuid",
                                                        "description": "The id of this way of writing the name. Send it back to keep it when the list is replaced."
                                                    },
                                                    "kind": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "written for the name in a script of its own, transliteration for the name carried into another script, phonetic for how it is pronounced."
                                                    },
                                                    "language": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "A BCP 47 language tag such as ko or ja, or null."
                                                    },
                                                    "script": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "An ISO 15924 script code such as Hang, Hani or Latn, or null."
                                                    },
                                                    "phonetic_system": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "For a pronunciation, the system it is written in, as the vCard PHONETIC parameter names it: ipa, piny, x-romaji, x-rr, x-other, or a token a device sent. Null for any other kind."
                                                    },
                                                    "formatted_name": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The full name exactly as it should appear, up to 255 characters, or null to build it from the parts. Always null for a pronunciation, which is written in its parts."
                                                    },
                                                    "prefix": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Up to 50 characters, or null."
                                                    },
                                                    "given_name": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Up to 255 characters, or null."
                                                    },
                                                    "additional_name": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Other given names, up to 255 characters, or null."
                                                    },
                                                    "family_name": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Up to 255 characters, or null."
                                                    },
                                                    "suffix": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Up to 50 characters, or null."
                                                    },
                                                    "name_order": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Either given_first or family_first, or null to leave it to the reader."
                                                    },
                                                    "position": {
                                                        "type": [
                                                            "integer",
                                                            "null"
                                                        ],
                                                        "description": "Where it stands in the list, from 1."
                                                    },
                                                    "is_display": {
                                                        "type": [
                                                            "boolean",
                                                            "null"
                                                        ],
                                                        "description": "Whether this is the way the contact is shown under, in lists, titles, notifications and initials. Exactly one is, whenever the contact has a name."
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "id": "0e6d3b1a-52c7-4f9e-8a41-b7d2c96f0e13",
                                            "kind": "written",
                                            "language": null,
                                            "script": null,
                                            "phonetic_system": null,
                                            "formatted_name": null,
                                            "prefix": null,
                                            "given_name": "Pam",
                                            "additional_name": null,
                                            "family_name": "Beesly",
                                            "suffix": null,
                                            "name_order": "given_first",
                                            "position": 1,
                                            "is_display": true
                                        },
                                        {
                                            "id": "4b91f2c8-6d03-4e57-a9b1-3c8e0d7f5a26",
                                            "kind": "transliteration",
                                            "language": "ja",
                                            "script": "Kana",
                                            "phonetic_system": null,
                                            "formatted_name": "パム・ビーズリー",
                                            "prefix": null,
                                            "given_name": null,
                                            "additional_name": null,
                                            "family_name": null,
                                            "suffix": null,
                                            "name_order": null,
                                            "position": 2,
                                            "is_display": false
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "contacts-name-representations-index-query",
                "tags": [
                    "Contacts"
                ],
                "summary": "List the ways a name is written",
                "description": "Retrieve every way the current name of a contact is written, and which one it is shown under.\n\n김민지, Kim Min-ji and 金敏智 are three ways of writing one name, not three names. Former names and nicknames are not here.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the contact lives in, named either by the readable name it reports as slug or by its id. Both answer.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "contact",
                        "in": "path",
                        "required": true,
                        "description": "The contact, named either by the readable name it reports as slug or by its id. Both answer. A readable name is rebuilt whenever the record is renamed, and the previous one stops answering, so a client that stores a reference stores the id. A name a record has released is never given to another. The contact has to be in the vault the path names: a contact of yours addressed through the wrong vault answers 404, the same as one that never existed. A contact absorbed by a merge answers 404 here, and the merge endpoints say what became of them.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The list, possibly empty. A contact belonging to somebody else, or reached through the wrong vault, answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "Every way the name is written, in order.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One way of writing the name.",
                                                "properties": {
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "format": "uuid",
                                                        "description": "The id of this way of writing the name. Send it back to keep it when the list is replaced."
                                                    },
                                                    "kind": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "written for the name in a script of its own, transliteration for the name carried into another script, phonetic for how it is pronounced."
                                                    },
                                                    "language": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "A BCP 47 language tag such as ko or ja, or null."
                                                    },
                                                    "script": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "An ISO 15924 script code such as Hang, Hani or Latn, or null."
                                                    },
                                                    "phonetic_system": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "For a pronunciation, the system it is written in, as the vCard PHONETIC parameter names it: ipa, piny, x-romaji, x-rr, x-other, or a token a device sent. Null for any other kind."
                                                    },
                                                    "formatted_name": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The full name exactly as it should appear, up to 255 characters, or null to build it from the parts. Always null for a pronunciation, which is written in its parts."
                                                    },
                                                    "prefix": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Up to 50 characters, or null."
                                                    },
                                                    "given_name": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Up to 255 characters, or null."
                                                    },
                                                    "additional_name": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Other given names, up to 255 characters, or null."
                                                    },
                                                    "family_name": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Up to 255 characters, or null."
                                                    },
                                                    "suffix": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Up to 50 characters, or null."
                                                    },
                                                    "name_order": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Either given_first or family_first, or null to leave it to the reader."
                                                    },
                                                    "position": {
                                                        "type": [
                                                            "integer",
                                                            "null"
                                                        ],
                                                        "description": "Where it stands in the list, from 1."
                                                    },
                                                    "is_display": {
                                                        "type": [
                                                            "boolean",
                                                            "null"
                                                        ],
                                                        "description": "Whether this is the way the contact is shown under, in lists, titles, notifications and initials. Exactly one is, whenever the contact has a name."
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "id": "0e6d3b1a-52c7-4f9e-8a41-b7d2c96f0e13",
                                            "kind": "written",
                                            "language": null,
                                            "script": null,
                                            "phonetic_system": null,
                                            "formatted_name": null,
                                            "prefix": null,
                                            "given_name": "Pam",
                                            "additional_name": null,
                                            "family_name": "Beesly",
                                            "suffix": null,
                                            "name_order": "given_first",
                                            "position": 1,
                                            "is_display": true
                                        },
                                        {
                                            "id": "4b91f2c8-6d03-4e57-a9b1-3c8e0d7f5a26",
                                            "kind": "transliteration",
                                            "language": "ja",
                                            "script": "Kana",
                                            "phonetic_system": null,
                                            "formatted_name": "パム・ビーズリー",
                                            "prefix": null,
                                            "given_name": null,
                                            "additional_name": null,
                                            "family_name": null,
                                            "suffix": null,
                                            "name_order": null,
                                            "position": 2,
                                            "is_display": false
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "put": {
                "operationId": "contacts-name-representations-update",
                "tags": [
                    "Contacts"
                ],
                "summary": "Replace the ways a name is written",
                "description": "Send the list of ways the name is written, and say which one the contact is shown under.\n\nThe list is sent whole. Left out of the body, the ways of writing the name stay as they are. Sent, the list sent is the list kept: a way of writing the name that carries an id is updated, one without is added, and one left out is deleted. An empty list leaves the contact with no name, which still sorts, searches and draws initials.\n\nChanging a way of writing the name other than the one shown leaves the readable address and the place in the list alone, and the contact is found by the new text at once.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the contact lives in, named either by the readable name it reports as slug or by its id. Both answer.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "contact",
                        "in": "path",
                        "required": true,
                        "description": "The contact, named either by the readable name it reports as slug or by its id. Both answer. A readable name is rebuilt whenever the record is renamed, and the previous one stops answering, so a client that stores a reference stores the id. A name a record has released is never given to another. The contact has to be in the vault the path names: a contact of yours addressed through the wrong vault answers 404, the same as one that never existed. A contact absorbed by a merge answers 404 here, and the merge endpoints say what became of them.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name_representations": {
                                        "type": "array",
                                        "description": "Every way the name is written, in order, at most 20. Each has the fields listed above except position and is_display, and needs a formatted name or at least one part. An id that is not one of this contact's is refused."
                                    },
                                    "display": {
                                        "type": "integer",
                                        "description": "The position in the list, from 0, of the way the contact is shown under. Required when a list is sent and is not empty. Left out with no list, the way shown stays the same. It cannot be a pronunciation."
                                    },
                                    "nickname": {
                                        "type": "string",
                                        "description": "Up to 255 characters, or null."
                                    },
                                    "maiden_name": {
                                        "type": "string",
                                        "description": "Up to 255 characters, or null."
                                    }
                                }
                            },
                            "example": {
                                "name_representations": [
                                    {
                                        "id": "0e6d3b1a-52c7-4f9e-8a41-b7d2c96f0e13",
                                        "kind": "written",
                                        "language": null,
                                        "script": null,
                                        "phonetic_system": null,
                                        "formatted_name": null,
                                        "prefix": null,
                                        "given_name": "Pam",
                                        "additional_name": null,
                                        "family_name": "Beesly",
                                        "suffix": null,
                                        "name_order": "given_first",
                                        "position": 1,
                                        "is_display": true
                                    },
                                    {
                                        "id": "4b91f2c8-6d03-4e57-a9b1-3c8e0d7f5a26",
                                        "kind": "transliteration",
                                        "language": "ja",
                                        "script": "Kana",
                                        "phonetic_system": null,
                                        "formatted_name": "パム・ビーズリー",
                                        "prefix": null,
                                        "given_name": null,
                                        "additional_name": null,
                                        "family_name": null,
                                        "suffix": null,
                                        "name_order": null,
                                        "position": 2,
                                        "is_display": false
                                    }
                                ],
                                "display": 0,
                                "nickname": "Pammy"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The contact object as it now reads. A pronunciation with no system or with a full name, a pronunciation chosen for display, a malformed language or script, the same id sent twice, or an id belonging to another contact answers 422 and changes nothing. A contact belonging to somebody else, or reached through the wrong vault, answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The contact.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always contact. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "slug": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The readable name the contact is addressed by, built from the whole name above and unique within the vault. It keeps the alphabet the name is written in, so a name in Japanese is addressed in Japanese, sent as its own characters or percent encoded. It is not stable: correcting the name rebuilds it and the previous one stops answering, which is why a stored reference should be the id. Nothing lets you choose or edit it."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The name the contact is shown under: the formatted name of the way of writing it chosen for display, else its parts in the order it reads in. It is what the lists sort on, and it is built rather than stored, so it cannot be written directly."
                                                        },
                                                        "formatted_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The full name exactly as written for the way of writing it chosen for display, or null when that way is only parts."
                                                        },
                                                        "name_representations": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "Every way the current name is written: in its own script, transliterated into another, or as it is pronounced, in the order the owner put them. Every one of them finds the contact in a search. Nothing is transliterated for you.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One way of writing the name.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of this way of writing the name. Send it back to keep it when the list is replaced."
                                                                    },
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "written for the name in a script of its own, transliteration for the name carried into another script, phonetic for how it is pronounced."
                                                                    },
                                                                    "language": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "A BCP 47 language tag such as ko or ja, or null."
                                                                    },
                                                                    "script": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "An ISO 15924 script code such as Hang, Hani or Latn, or null."
                                                                    },
                                                                    "phonetic_system": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "For a pronunciation, the system it is written in, as the vCard PHONETIC parameter names it: ipa, piny, x-romaji, x-rr, x-other, or a token a device sent. Null for any other kind."
                                                                    },
                                                                    "formatted_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The full name exactly as it should appear, up to 255 characters, or null to build it from the parts. Always null for a pronunciation, which is written in its parts."
                                                                    },
                                                                    "prefix": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 50 characters, or null."
                                                                    },
                                                                    "given_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 255 characters, or null."
                                                                    },
                                                                    "additional_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Other given names, up to 255 characters, or null."
                                                                    },
                                                                    "family_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 255 characters, or null."
                                                                    },
                                                                    "suffix": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 50 characters, or null."
                                                                    },
                                                                    "name_order": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Either given_first or family_first, or null to leave it to the reader."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Where it stands in the list, from 1."
                                                                    },
                                                                    "is_display": {
                                                                        "type": [
                                                                            "boolean",
                                                                            "null"
                                                                        ],
                                                                        "description": "Whether this is the way the contact is shown under, in lists, titles, notifications and initials. Exactly one is, whenever the contact has a name."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "prefix": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What comes before the name, up to 50 characters, or null. Dr and Sir are prefixes."
                                                        },
                                                        "first_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The given name of the way of writing the name chosen for display, up to 255 characters, or null. Like the prefix, the middle name, the last name, the suffix and the name order, it is a copy read from that way of writing it."
                                                        },
                                                        "middle_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Up to 255 characters, or null."
                                                        },
                                                        "last_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The family name, up to 255 characters, or null."
                                                        },
                                                        "suffix": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What comes after the name, up to 50 characters, or null. Jr and PhD are suffixes."
                                                        },
                                                        "maiden_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Up to 255 characters, or null."
                                                        },
                                                        "nickname": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What this person is actually called, up to 255 characters, or null. It is searched as it was typed rather than folded, and it is what the whole name falls back to when no other part is set."
                                                        },
                                                        "name_order": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either given_first or family_first, or null to leave it to the reader. It is a fact about this person rather than a preference of yours, which is what lets a Japanese name keep its order in a list of western ones."
                                                        },
                                                        "initials": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The one or two letters drawn when the contact has no picture. Built from the name, so it cannot be written."
                                                        },
                                                        "avatar_colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The background those initials are drawn on, as a hex colour. It is chosen when the contact is written down and never changes afterwards, so somebody who has learnt to spot a face in a list does not have it move."
                                                        },
                                                        "avatar": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The picture, or null when the contact is drawn as its initials.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the file the picture was stored as. It is a file of the vault like any other, so it counts against your storage."
                                                                },
                                                                "url": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "Where the picture is served from. This address is served by the application and needs a signed in session rather than a token: no endpoint here streams a vault's files yet, and a document is as private as the record it sits on."
                                                                }
                                                            }
                                                        },
                                                        "is_favourite": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the contact sits at the top of the list."
                                                        },
                                                        "is_archived": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the contact has been put away. An archived contact is left out of every list. Reading this is possible here; changing it is not, because no screen offers the gesture either."
                                                        },
                                                        "is_partial": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the contact is somebody mentioned in a relationship and reduced to a first name. A partial contact is off every list until somebody fills them in, so it is listed by no filter at all."
                                                        },
                                                        "is_me": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether this contact represents you. Exactly one contact per vault is, it cannot be deleted, and nothing here hands the title to somebody else."
                                                        },
                                                        "age": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How old the contact is in whole years, on your current day in your time zone. Null when the birthday is not recorded, when its year or its month is unknown, or when its date lies in the future. Null too when the birthday field is sensitive and the key lacks the sensitive-fields ability. It is worked out on every read and never stored."
                                                        },
                                                        "next_birthday_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The next birthday as a date written Y-m-d, on or after your current day in your time zone, so it is today's date on the birthday itself. A birthday on 29 February falls on 28 February in a year without one. Null when the birthday is not recorded, when its month is unknown, or when the birthday field is sensitive and the key lacks the sensitive-fields ability."
                                                        },
                                                        "structure_version_id": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The published version of the template this contact renders from. It says what pages the contact has and what is written on them. Publishing a new version moves nobody: a contact stays on the version it points at until it is moved."
                                                        },
                                                        "template_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What that template is called, which is what the lists show beside a contact."
                                                        },
                                                        "categories": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The categories the contact holds, in the order of your list of contact categories. A category is a choice of that list held in any field of the template drawing on it. Empty when the contact holds none.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One category.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "The id of the category, which is what the list of contacts filters on."
                                                                    },
                                                                    "label": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the category is called, in the language of the request for a category the application supplied."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "last_life_event_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact last took part in a life event, as a count of seconds since 1970, or null when they never have. It says nothing about whether you were there."
                                                        },
                                                        "last_interaction_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The Last in touch date: the day of the latest life event the contact took part in that has already happened and whose nature has updates_last_in_touch, as a count of seconds since 1970, or null when there is none. This is what Last in touch and Last spoke read."
                                                        },
                                                        "last_consulted_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact was last consulted on their own, as a count of seconds since 1970, or null when they never have been: their page opened in Monica, the contact read through this endpoint, or read by an assistant connected over MCP. Listing contacts does not change it."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact was written down, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The page of the contact in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "contact",
                                        "id": "c4a1f7b2-8e36-4d59-b0a7-2f5c9d81e364",
                                        "attributes": {
                                            "slug": "pam-beesly",
                                            "name": "Pam Beesly",
                                            "formatted_name": null,
                                            "name_representations": [
                                                {
                                                    "id": "0e6d3b1a-52c7-4f9e-8a41-b7d2c96f0e13",
                                                    "kind": "written",
                                                    "language": null,
                                                    "script": null,
                                                    "phonetic_system": null,
                                                    "formatted_name": null,
                                                    "prefix": null,
                                                    "given_name": "Pam",
                                                    "additional_name": null,
                                                    "family_name": "Beesly",
                                                    "suffix": null,
                                                    "name_order": "given_first",
                                                    "position": 1,
                                                    "is_display": true
                                                },
                                                {
                                                    "id": "4b91f2c8-6d03-4e57-a9b1-3c8e0d7f5a26",
                                                    "kind": "transliteration",
                                                    "language": "ja",
                                                    "script": "Kana",
                                                    "phonetic_system": null,
                                                    "formatted_name": "パム・ビーズリー",
                                                    "prefix": null,
                                                    "given_name": null,
                                                    "additional_name": null,
                                                    "family_name": null,
                                                    "suffix": null,
                                                    "name_order": null,
                                                    "position": 2,
                                                    "is_display": false
                                                }
                                            ],
                                            "prefix": null,
                                            "first_name": "Pam",
                                            "middle_name": null,
                                            "last_name": "Beesly",
                                            "suffix": null,
                                            "maiden_name": null,
                                            "nickname": "Pammy",
                                            "name_order": "given_first",
                                            "initials": "PB",
                                            "avatar_colour": "#0ea5e9",
                                            "avatar": {
                                                "id": "3f6c1d90-4b27-4e85-a1c3-9d720f5b8e46",
                                                "url": "https://my.monicahq.com/api/v1/vaults/9d4f1c2e-7b3a-4f88-9a2d-6c1e5b0f7a31/files/3f6c1d90-4b27-4e85-a1c3-9d720f5b8e46"
                                            },
                                            "is_favourite": true,
                                            "is_archived": false,
                                            "is_partial": false,
                                            "is_me": false,
                                            "age": 36,
                                            "next_birthday_on": "2026-03-14",
                                            "structure_version_id": 4,
                                            "template_name": "Default contact",
                                            "categories": [
                                                {
                                                    "id": 12,
                                                    "label": "Colleague"
                                                }
                                            ],
                                            "last_life_event_at": null,
                                            "created_at": 1756252800,
                                            "last_interaction_at": null,
                                            "last_consulted_at": 1756339200,
                                            "updated_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/pam-beesly",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/contacts/pam-beesly"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/contacts/{contact}/favourite": {
            "put": {
                "operationId": "contacts-favourite-update",
                "tags": [
                    "Contacts"
                ],
                "summary": "Mark a favourite",
                "description": "Say whether a contact sits at the top of the list.\n\nSend the state you want rather than asking for a toggle. Two callers acting on a stale reading would each invert what the other had just written, and neither would end up with what it asked for. Sending the state means the worst a repeat can do is confirm what is already stored.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the contact lives in, named either by the readable name it reports as slug or by its id. Both answer.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "contact",
                        "in": "path",
                        "required": true,
                        "description": "The contact, named either by the readable name it reports as slug or by its id. Both answer. A readable name is rebuilt whenever the record is renamed, and the previous one stops answering, so a client that stores a reference stores the id. A name a record has released is never given to another. The contact has to be in the vault the path names: a contact of yours addressed through the wrong vault answers 404, the same as one that never existed. A contact absorbed by a merge answers 404 here, and the merge endpoints say what became of them.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "favourite": {
                                        "type": "boolean",
                                        "description": "True to mark the contact a favourite, false to take the mark off. Sending the state it is already in is allowed and changes nothing."
                                    }
                                },
                                "required": [
                                    "favourite"
                                ]
                            },
                            "example": {
                                "favourite": true
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The contact object as it now reads. A contact belonging to somebody else, or reached through the wrong vault, answers 404 and is left as it was.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The contact.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always contact. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "slug": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The readable name the contact is addressed by, built from the whole name above and unique within the vault. It keeps the alphabet the name is written in, so a name in Japanese is addressed in Japanese, sent as its own characters or percent encoded. It is not stable: correcting the name rebuilds it and the previous one stops answering, which is why a stored reference should be the id. Nothing lets you choose or edit it."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The name the contact is shown under: the formatted name of the way of writing it chosen for display, else its parts in the order it reads in. It is what the lists sort on, and it is built rather than stored, so it cannot be written directly."
                                                        },
                                                        "formatted_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The full name exactly as written for the way of writing it chosen for display, or null when that way is only parts."
                                                        },
                                                        "name_representations": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "Every way the current name is written: in its own script, transliterated into another, or as it is pronounced, in the order the owner put them. Every one of them finds the contact in a search. Nothing is transliterated for you.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One way of writing the name.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of this way of writing the name. Send it back to keep it when the list is replaced."
                                                                    },
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "written for the name in a script of its own, transliteration for the name carried into another script, phonetic for how it is pronounced."
                                                                    },
                                                                    "language": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "A BCP 47 language tag such as ko or ja, or null."
                                                                    },
                                                                    "script": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "An ISO 15924 script code such as Hang, Hani or Latn, or null."
                                                                    },
                                                                    "phonetic_system": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "For a pronunciation, the system it is written in, as the vCard PHONETIC parameter names it: ipa, piny, x-romaji, x-rr, x-other, or a token a device sent. Null for any other kind."
                                                                    },
                                                                    "formatted_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The full name exactly as it should appear, up to 255 characters, or null to build it from the parts. Always null for a pronunciation, which is written in its parts."
                                                                    },
                                                                    "prefix": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 50 characters, or null."
                                                                    },
                                                                    "given_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 255 characters, or null."
                                                                    },
                                                                    "additional_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Other given names, up to 255 characters, or null."
                                                                    },
                                                                    "family_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 255 characters, or null."
                                                                    },
                                                                    "suffix": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 50 characters, or null."
                                                                    },
                                                                    "name_order": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Either given_first or family_first, or null to leave it to the reader."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Where it stands in the list, from 1."
                                                                    },
                                                                    "is_display": {
                                                                        "type": [
                                                                            "boolean",
                                                                            "null"
                                                                        ],
                                                                        "description": "Whether this is the way the contact is shown under, in lists, titles, notifications and initials. Exactly one is, whenever the contact has a name."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "prefix": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What comes before the name, up to 50 characters, or null. Dr and Sir are prefixes."
                                                        },
                                                        "first_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The given name of the way of writing the name chosen for display, up to 255 characters, or null. Like the prefix, the middle name, the last name, the suffix and the name order, it is a copy read from that way of writing it."
                                                        },
                                                        "middle_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Up to 255 characters, or null."
                                                        },
                                                        "last_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The family name, up to 255 characters, or null."
                                                        },
                                                        "suffix": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What comes after the name, up to 50 characters, or null. Jr and PhD are suffixes."
                                                        },
                                                        "maiden_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Up to 255 characters, or null."
                                                        },
                                                        "nickname": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What this person is actually called, up to 255 characters, or null. It is searched as it was typed rather than folded, and it is what the whole name falls back to when no other part is set."
                                                        },
                                                        "name_order": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either given_first or family_first, or null to leave it to the reader. It is a fact about this person rather than a preference of yours, which is what lets a Japanese name keep its order in a list of western ones."
                                                        },
                                                        "initials": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The one or two letters drawn when the contact has no picture. Built from the name, so it cannot be written."
                                                        },
                                                        "avatar_colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The background those initials are drawn on, as a hex colour. It is chosen when the contact is written down and never changes afterwards, so somebody who has learnt to spot a face in a list does not have it move."
                                                        },
                                                        "avatar": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The picture, or null when the contact is drawn as its initials.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the file the picture was stored as. It is a file of the vault like any other, so it counts against your storage."
                                                                },
                                                                "url": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "Where the picture is served from. This address is served by the application and needs a signed in session rather than a token: no endpoint here streams a vault's files yet, and a document is as private as the record it sits on."
                                                                }
                                                            }
                                                        },
                                                        "is_favourite": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the contact sits at the top of the list."
                                                        },
                                                        "is_archived": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the contact has been put away. An archived contact is left out of every list. Reading this is possible here; changing it is not, because no screen offers the gesture either."
                                                        },
                                                        "is_partial": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the contact is somebody mentioned in a relationship and reduced to a first name. A partial contact is off every list until somebody fills them in, so it is listed by no filter at all."
                                                        },
                                                        "is_me": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether this contact represents you. Exactly one contact per vault is, it cannot be deleted, and nothing here hands the title to somebody else."
                                                        },
                                                        "age": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How old the contact is in whole years, on your current day in your time zone. Null when the birthday is not recorded, when its year or its month is unknown, or when its date lies in the future. Null too when the birthday field is sensitive and the key lacks the sensitive-fields ability. It is worked out on every read and never stored."
                                                        },
                                                        "next_birthday_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The next birthday as a date written Y-m-d, on or after your current day in your time zone, so it is today's date on the birthday itself. A birthday on 29 February falls on 28 February in a year without one. Null when the birthday is not recorded, when its month is unknown, or when the birthday field is sensitive and the key lacks the sensitive-fields ability."
                                                        },
                                                        "structure_version_id": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The published version of the template this contact renders from. It says what pages the contact has and what is written on them. Publishing a new version moves nobody: a contact stays on the version it points at until it is moved."
                                                        },
                                                        "template_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What that template is called, which is what the lists show beside a contact."
                                                        },
                                                        "categories": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The categories the contact holds, in the order of your list of contact categories. A category is a choice of that list held in any field of the template drawing on it. Empty when the contact holds none.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One category.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "The id of the category, which is what the list of contacts filters on."
                                                                    },
                                                                    "label": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the category is called, in the language of the request for a category the application supplied."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "last_life_event_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact last took part in a life event, as a count of seconds since 1970, or null when they never have. It says nothing about whether you were there."
                                                        },
                                                        "last_interaction_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The Last in touch date: the day of the latest life event the contact took part in that has already happened and whose nature has updates_last_in_touch, as a count of seconds since 1970, or null when there is none. This is what Last in touch and Last spoke read."
                                                        },
                                                        "last_consulted_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact was last consulted on their own, as a count of seconds since 1970, or null when they never have been: their page opened in Monica, the contact read through this endpoint, or read by an assistant connected over MCP. Listing contacts does not change it."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact was written down, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The page of the contact in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "contact",
                                        "id": "c4a1f7b2-8e36-4d59-b0a7-2f5c9d81e364",
                                        "attributes": {
                                            "slug": "pam-beesly",
                                            "name": "Pam Beesly",
                                            "formatted_name": null,
                                            "name_representations": [
                                                {
                                                    "id": "0e6d3b1a-52c7-4f9e-8a41-b7d2c96f0e13",
                                                    "kind": "written",
                                                    "language": null,
                                                    "script": null,
                                                    "phonetic_system": null,
                                                    "formatted_name": null,
                                                    "prefix": null,
                                                    "given_name": "Pam",
                                                    "additional_name": null,
                                                    "family_name": "Beesly",
                                                    "suffix": null,
                                                    "name_order": "given_first",
                                                    "position": 1,
                                                    "is_display": true
                                                }
                                            ],
                                            "prefix": null,
                                            "first_name": "Pam",
                                            "middle_name": null,
                                            "last_name": "Beesly",
                                            "suffix": null,
                                            "maiden_name": null,
                                            "nickname": "Pammy",
                                            "name_order": "given_first",
                                            "initials": "PB",
                                            "avatar_colour": "#0ea5e9",
                                            "avatar": {
                                                "id": "3f6c1d90-4b27-4e85-a1c3-9d720f5b8e46",
                                                "url": "https://my.monicahq.com/api/v1/vaults/9d4f1c2e-7b3a-4f88-9a2d-6c1e5b0f7a31/files/3f6c1d90-4b27-4e85-a1c3-9d720f5b8e46"
                                            },
                                            "is_favourite": true,
                                            "is_archived": false,
                                            "is_partial": false,
                                            "is_me": false,
                                            "age": 36,
                                            "next_birthday_on": "2026-03-14",
                                            "structure_version_id": 4,
                                            "template_name": "Default contact",
                                            "categories": [
                                                {
                                                    "id": 12,
                                                    "label": "Colleague"
                                                }
                                            ],
                                            "last_life_event_at": null,
                                            "created_at": 1756252800,
                                            "last_interaction_at": null,
                                            "last_consulted_at": 1756339200,
                                            "updated_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/pam-beesly",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/contacts/pam-beesly"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/contacts/{contact}/avatar": {
            "post": {
                "operationId": "contacts-avatar-update",
                "tags": [
                    "Contacts"
                ],
                "summary": "Put a picture on a contact",
                "description": "Upload the picture a contact is drawn as, in place of their initials.\n\nSend the file as multipart form data, in a field called avatar. This is a POST rather than a PUT because PHP reads an uploaded file on a POST and on nothing else.\n\nThe picture is cropped square and becomes a file of the vault like any other, which is what makes your storage quota apply to it. An upload that would take the account past what it has left answers 422 and the contact keeps whatever picture it had.\n\nA contact has one picture. Replacing it lets the previous file go rather than deleting it outright, because a vault's files outlive what pointed at them.\n\nThe address the picture comes back under is served by the application and needs a signed in session rather than a token. No endpoint here streams a vault's files yet.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the contact lives in, named either by the readable name it reports as slug or by its id. Both answer.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "contact",
                        "in": "path",
                        "required": true,
                        "description": "The contact, named either by the readable name it reports as slug or by its id. Both answer. A readable name is rebuilt whenever the record is renamed, and the previous one stops answering, so a client that stores a reference stores the id. A name a record has released is never given to another. The contact has to be in the vault the path names: a contact of yours addressed through the wrong vault answers 404, the same as one that never existed. A contact absorbed by a merge answers 404 here, and the merge endpoints say what became of them.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "multipart/form-data": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "avatar": {
                                        "type": "string",
                                        "format": "binary",
                                        "description": "A jpeg, png or webp image, at most 5 MB. The type is checked on what the file actually is rather than on what its name claims."
                                    }
                                },
                                "required": [
                                    "avatar"
                                ]
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The contact object as it now reads, with avatar filled in. A contact belonging to somebody else, or reached through the wrong vault, answers 404 and nothing is uploaded.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The contact.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always contact. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "slug": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The readable name the contact is addressed by, built from the whole name above and unique within the vault. It keeps the alphabet the name is written in, so a name in Japanese is addressed in Japanese, sent as its own characters or percent encoded. It is not stable: correcting the name rebuilds it and the previous one stops answering, which is why a stored reference should be the id. Nothing lets you choose or edit it."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The name the contact is shown under: the formatted name of the way of writing it chosen for display, else its parts in the order it reads in. It is what the lists sort on, and it is built rather than stored, so it cannot be written directly."
                                                        },
                                                        "formatted_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The full name exactly as written for the way of writing it chosen for display, or null when that way is only parts."
                                                        },
                                                        "name_representations": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "Every way the current name is written: in its own script, transliterated into another, or as it is pronounced, in the order the owner put them. Every one of them finds the contact in a search. Nothing is transliterated for you.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One way of writing the name.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of this way of writing the name. Send it back to keep it when the list is replaced."
                                                                    },
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "written for the name in a script of its own, transliteration for the name carried into another script, phonetic for how it is pronounced."
                                                                    },
                                                                    "language": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "A BCP 47 language tag such as ko or ja, or null."
                                                                    },
                                                                    "script": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "An ISO 15924 script code such as Hang, Hani or Latn, or null."
                                                                    },
                                                                    "phonetic_system": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "For a pronunciation, the system it is written in, as the vCard PHONETIC parameter names it: ipa, piny, x-romaji, x-rr, x-other, or a token a device sent. Null for any other kind."
                                                                    },
                                                                    "formatted_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The full name exactly as it should appear, up to 255 characters, or null to build it from the parts. Always null for a pronunciation, which is written in its parts."
                                                                    },
                                                                    "prefix": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 50 characters, or null."
                                                                    },
                                                                    "given_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 255 characters, or null."
                                                                    },
                                                                    "additional_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Other given names, up to 255 characters, or null."
                                                                    },
                                                                    "family_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 255 characters, or null."
                                                                    },
                                                                    "suffix": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 50 characters, or null."
                                                                    },
                                                                    "name_order": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Either given_first or family_first, or null to leave it to the reader."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Where it stands in the list, from 1."
                                                                    },
                                                                    "is_display": {
                                                                        "type": [
                                                                            "boolean",
                                                                            "null"
                                                                        ],
                                                                        "description": "Whether this is the way the contact is shown under, in lists, titles, notifications and initials. Exactly one is, whenever the contact has a name."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "prefix": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What comes before the name, up to 50 characters, or null. Dr and Sir are prefixes."
                                                        },
                                                        "first_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The given name of the way of writing the name chosen for display, up to 255 characters, or null. Like the prefix, the middle name, the last name, the suffix and the name order, it is a copy read from that way of writing it."
                                                        },
                                                        "middle_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Up to 255 characters, or null."
                                                        },
                                                        "last_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The family name, up to 255 characters, or null."
                                                        },
                                                        "suffix": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What comes after the name, up to 50 characters, or null. Jr and PhD are suffixes."
                                                        },
                                                        "maiden_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Up to 255 characters, or null."
                                                        },
                                                        "nickname": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What this person is actually called, up to 255 characters, or null. It is searched as it was typed rather than folded, and it is what the whole name falls back to when no other part is set."
                                                        },
                                                        "name_order": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either given_first or family_first, or null to leave it to the reader. It is a fact about this person rather than a preference of yours, which is what lets a Japanese name keep its order in a list of western ones."
                                                        },
                                                        "initials": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The one or two letters drawn when the contact has no picture. Built from the name, so it cannot be written."
                                                        },
                                                        "avatar_colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The background those initials are drawn on, as a hex colour. It is chosen when the contact is written down and never changes afterwards, so somebody who has learnt to spot a face in a list does not have it move."
                                                        },
                                                        "avatar": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The picture, or null when the contact is drawn as its initials.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the file the picture was stored as. It is a file of the vault like any other, so it counts against your storage."
                                                                },
                                                                "url": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "Where the picture is served from. This address is served by the application and needs a signed in session rather than a token: no endpoint here streams a vault's files yet, and a document is as private as the record it sits on."
                                                                }
                                                            }
                                                        },
                                                        "is_favourite": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the contact sits at the top of the list."
                                                        },
                                                        "is_archived": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the contact has been put away. An archived contact is left out of every list. Reading this is possible here; changing it is not, because no screen offers the gesture either."
                                                        },
                                                        "is_partial": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the contact is somebody mentioned in a relationship and reduced to a first name. A partial contact is off every list until somebody fills them in, so it is listed by no filter at all."
                                                        },
                                                        "is_me": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether this contact represents you. Exactly one contact per vault is, it cannot be deleted, and nothing here hands the title to somebody else."
                                                        },
                                                        "age": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How old the contact is in whole years, on your current day in your time zone. Null when the birthday is not recorded, when its year or its month is unknown, or when its date lies in the future. Null too when the birthday field is sensitive and the key lacks the sensitive-fields ability. It is worked out on every read and never stored."
                                                        },
                                                        "next_birthday_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The next birthday as a date written Y-m-d, on or after your current day in your time zone, so it is today's date on the birthday itself. A birthday on 29 February falls on 28 February in a year without one. Null when the birthday is not recorded, when its month is unknown, or when the birthday field is sensitive and the key lacks the sensitive-fields ability."
                                                        },
                                                        "structure_version_id": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The published version of the template this contact renders from. It says what pages the contact has and what is written on them. Publishing a new version moves nobody: a contact stays on the version it points at until it is moved."
                                                        },
                                                        "template_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What that template is called, which is what the lists show beside a contact."
                                                        },
                                                        "categories": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The categories the contact holds, in the order of your list of contact categories. A category is a choice of that list held in any field of the template drawing on it. Empty when the contact holds none.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One category.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "The id of the category, which is what the list of contacts filters on."
                                                                    },
                                                                    "label": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the category is called, in the language of the request for a category the application supplied."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "last_life_event_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact last took part in a life event, as a count of seconds since 1970, or null when they never have. It says nothing about whether you were there."
                                                        },
                                                        "last_interaction_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The Last in touch date: the day of the latest life event the contact took part in that has already happened and whose nature has updates_last_in_touch, as a count of seconds since 1970, or null when there is none. This is what Last in touch and Last spoke read."
                                                        },
                                                        "last_consulted_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact was last consulted on their own, as a count of seconds since 1970, or null when they never have been: their page opened in Monica, the contact read through this endpoint, or read by an assistant connected over MCP. Listing contacts does not change it."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact was written down, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The page of the contact in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "contact",
                                        "id": "c4a1f7b2-8e36-4d59-b0a7-2f5c9d81e364",
                                        "attributes": {
                                            "slug": "pam-beesly",
                                            "name": "Pam Beesly",
                                            "formatted_name": null,
                                            "name_representations": [
                                                {
                                                    "id": "0e6d3b1a-52c7-4f9e-8a41-b7d2c96f0e13",
                                                    "kind": "written",
                                                    "language": null,
                                                    "script": null,
                                                    "phonetic_system": null,
                                                    "formatted_name": null,
                                                    "prefix": null,
                                                    "given_name": "Pam",
                                                    "additional_name": null,
                                                    "family_name": "Beesly",
                                                    "suffix": null,
                                                    "name_order": "given_first",
                                                    "position": 1,
                                                    "is_display": true
                                                }
                                            ],
                                            "prefix": null,
                                            "first_name": "Pam",
                                            "middle_name": null,
                                            "last_name": "Beesly",
                                            "suffix": null,
                                            "maiden_name": null,
                                            "nickname": "Pammy",
                                            "name_order": "given_first",
                                            "initials": "PB",
                                            "avatar_colour": "#0ea5e9",
                                            "avatar": {
                                                "id": "3f6c1d90-4b27-4e85-a1c3-9d720f5b8e46",
                                                "url": "https://my.monicahq.com/api/v1/vaults/9d4f1c2e-7b3a-4f88-9a2d-6c1e5b0f7a31/files/3f6c1d90-4b27-4e85-a1c3-9d720f5b8e46"
                                            },
                                            "is_favourite": true,
                                            "is_archived": false,
                                            "is_partial": false,
                                            "is_me": false,
                                            "age": 36,
                                            "next_birthday_on": "2026-03-14",
                                            "structure_version_id": 4,
                                            "template_name": "Default contact",
                                            "categories": [
                                                {
                                                    "id": 12,
                                                    "label": "Colleague"
                                                }
                                            ],
                                            "last_life_event_at": null,
                                            "created_at": 1756252800,
                                            "last_interaction_at": null,
                                            "last_consulted_at": 1756339200,
                                            "updated_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/pam-beesly",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/contacts/pam-beesly"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "delete": {
                "operationId": "contacts-avatar-destroy",
                "tags": [
                    "Contacts"
                ],
                "summary": "Remove a picture",
                "description": "Take the picture off a contact and draw their initials again.\n\nThe initials go back on the background the contact was given when it was written down. That background does not change, so somebody who has learnt to spot a face in a list does not have it move.\n\nThe file behind the picture is let go rather than deleted, so a restored snapshot can still find it for a while.\n\nA contact that has no picture answers exactly the same way, so calling this twice does not report a second removal.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the contact lives in, named either by the readable name it reports as slug or by its id. Both answer.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "contact",
                        "in": "path",
                        "required": true,
                        "description": "The contact, named either by the readable name it reports as slug or by its id. Both answer. A readable name is rebuilt whenever the record is renamed, and the previous one stops answering, so a client that stores a reference stores the id. A name a record has released is never given to another. The contact has to be in the vault the path names: a contact of yours addressed through the wrong vault answers 404, the same as one that never existed. A contact absorbed by a merge answers 404 here, and the merge endpoints say what became of them.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The contact object as it now reads, with avatar null. A contact belonging to somebody else, or reached through the wrong vault, answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The contact.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always contact. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "slug": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The readable name the contact is addressed by, built from the whole name above and unique within the vault. It keeps the alphabet the name is written in, so a name in Japanese is addressed in Japanese, sent as its own characters or percent encoded. It is not stable: correcting the name rebuilds it and the previous one stops answering, which is why a stored reference should be the id. Nothing lets you choose or edit it."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The name the contact is shown under: the formatted name of the way of writing it chosen for display, else its parts in the order it reads in. It is what the lists sort on, and it is built rather than stored, so it cannot be written directly."
                                                        },
                                                        "formatted_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The full name exactly as written for the way of writing it chosen for display, or null when that way is only parts."
                                                        },
                                                        "name_representations": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "Every way the current name is written: in its own script, transliterated into another, or as it is pronounced, in the order the owner put them. Every one of them finds the contact in a search. Nothing is transliterated for you.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One way of writing the name.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of this way of writing the name. Send it back to keep it when the list is replaced."
                                                                    },
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "written for the name in a script of its own, transliteration for the name carried into another script, phonetic for how it is pronounced."
                                                                    },
                                                                    "language": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "A BCP 47 language tag such as ko or ja, or null."
                                                                    },
                                                                    "script": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "An ISO 15924 script code such as Hang, Hani or Latn, or null."
                                                                    },
                                                                    "phonetic_system": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "For a pronunciation, the system it is written in, as the vCard PHONETIC parameter names it: ipa, piny, x-romaji, x-rr, x-other, or a token a device sent. Null for any other kind."
                                                                    },
                                                                    "formatted_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The full name exactly as it should appear, up to 255 characters, or null to build it from the parts. Always null for a pronunciation, which is written in its parts."
                                                                    },
                                                                    "prefix": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 50 characters, or null."
                                                                    },
                                                                    "given_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 255 characters, or null."
                                                                    },
                                                                    "additional_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Other given names, up to 255 characters, or null."
                                                                    },
                                                                    "family_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 255 characters, or null."
                                                                    },
                                                                    "suffix": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 50 characters, or null."
                                                                    },
                                                                    "name_order": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Either given_first or family_first, or null to leave it to the reader."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Where it stands in the list, from 1."
                                                                    },
                                                                    "is_display": {
                                                                        "type": [
                                                                            "boolean",
                                                                            "null"
                                                                        ],
                                                                        "description": "Whether this is the way the contact is shown under, in lists, titles, notifications and initials. Exactly one is, whenever the contact has a name."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "prefix": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What comes before the name, up to 50 characters, or null. Dr and Sir are prefixes."
                                                        },
                                                        "first_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The given name of the way of writing the name chosen for display, up to 255 characters, or null. Like the prefix, the middle name, the last name, the suffix and the name order, it is a copy read from that way of writing it."
                                                        },
                                                        "middle_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Up to 255 characters, or null."
                                                        },
                                                        "last_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The family name, up to 255 characters, or null."
                                                        },
                                                        "suffix": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What comes after the name, up to 50 characters, or null. Jr and PhD are suffixes."
                                                        },
                                                        "maiden_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Up to 255 characters, or null."
                                                        },
                                                        "nickname": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What this person is actually called, up to 255 characters, or null. It is searched as it was typed rather than folded, and it is what the whole name falls back to when no other part is set."
                                                        },
                                                        "name_order": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either given_first or family_first, or null to leave it to the reader. It is a fact about this person rather than a preference of yours, which is what lets a Japanese name keep its order in a list of western ones."
                                                        },
                                                        "initials": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The one or two letters drawn when the contact has no picture. Built from the name, so it cannot be written."
                                                        },
                                                        "avatar_colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The background those initials are drawn on, as a hex colour. It is chosen when the contact is written down and never changes afterwards, so somebody who has learnt to spot a face in a list does not have it move."
                                                        },
                                                        "avatar": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "Always null here. A contact is written down before it has a picture, and putting one on is its own call."
                                                        },
                                                        "is_favourite": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the contact sits at the top of the list."
                                                        },
                                                        "is_archived": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the contact has been put away. An archived contact is left out of every list. Reading this is possible here; changing it is not, because no screen offers the gesture either."
                                                        },
                                                        "is_partial": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the contact is somebody mentioned in a relationship and reduced to a first name. A partial contact is off every list until somebody fills them in, so it is listed by no filter at all."
                                                        },
                                                        "is_me": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether this contact represents you. Exactly one contact per vault is, it cannot be deleted, and nothing here hands the title to somebody else."
                                                        },
                                                        "age": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How old the contact is in whole years, on your current day in your time zone. Null when the birthday is not recorded, when its year or its month is unknown, or when its date lies in the future. Null too when the birthday field is sensitive and the key lacks the sensitive-fields ability. It is worked out on every read and never stored."
                                                        },
                                                        "next_birthday_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The next birthday as a date written Y-m-d, on or after your current day in your time zone, so it is today's date on the birthday itself. A birthday on 29 February falls on 28 February in a year without one. Null when the birthday is not recorded, when its month is unknown, or when the birthday field is sensitive and the key lacks the sensitive-fields ability."
                                                        },
                                                        "structure_version_id": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The published version of the template this contact renders from. It says what pages the contact has and what is written on them. Publishing a new version moves nobody: a contact stays on the version it points at until it is moved."
                                                        },
                                                        "template_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What that template is called, which is what the lists show beside a contact."
                                                        },
                                                        "categories": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The categories the contact holds, in the order of your list of contact categories. A category is a choice of that list held in any field of the template drawing on it. Empty when the contact holds none.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One category.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "The id of the category, which is what the list of contacts filters on."
                                                                    },
                                                                    "label": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the category is called, in the language of the request for a category the application supplied."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "last_life_event_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact last took part in a life event, as a count of seconds since 1970, or null when they never have. It says nothing about whether you were there."
                                                        },
                                                        "last_interaction_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The Last in touch date: the day of the latest life event the contact took part in that has already happened and whose nature has updates_last_in_touch, as a count of seconds since 1970, or null when there is none. This is what Last in touch and Last spoke read."
                                                        },
                                                        "last_consulted_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact was last consulted on their own, as a count of seconds since 1970, or null when they never have been: their page opened in Monica, the contact read through this endpoint, or read by an assistant connected over MCP. Listing contacts does not change it."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact was written down, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The page of the contact in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "contact",
                                        "id": "c4a1f7b2-8e36-4d59-b0a7-2f5c9d81e364",
                                        "attributes": {
                                            "slug": "pam-beesly",
                                            "name": "Pam Beesly",
                                            "formatted_name": null,
                                            "name_representations": [
                                                {
                                                    "id": "0e6d3b1a-52c7-4f9e-8a41-b7d2c96f0e13",
                                                    "kind": "written",
                                                    "language": null,
                                                    "script": null,
                                                    "phonetic_system": null,
                                                    "formatted_name": null,
                                                    "prefix": null,
                                                    "given_name": "Pam",
                                                    "additional_name": null,
                                                    "family_name": "Beesly",
                                                    "suffix": null,
                                                    "name_order": "given_first",
                                                    "position": 1,
                                                    "is_display": true
                                                }
                                            ],
                                            "prefix": null,
                                            "first_name": "Pam",
                                            "middle_name": null,
                                            "last_name": "Beesly",
                                            "suffix": null,
                                            "maiden_name": null,
                                            "nickname": "Pammy",
                                            "name_order": "given_first",
                                            "initials": "PB",
                                            "avatar_colour": "#0ea5e9",
                                            "avatar": null,
                                            "is_favourite": true,
                                            "is_archived": false,
                                            "is_partial": false,
                                            "is_me": false,
                                            "age": 36,
                                            "next_birthday_on": "2026-03-14",
                                            "structure_version_id": 4,
                                            "template_name": "Default contact",
                                            "categories": [
                                                {
                                                    "id": 12,
                                                    "label": "Colleague"
                                                }
                                            ],
                                            "last_life_event_at": null,
                                            "created_at": 1756252800,
                                            "last_interaction_at": null,
                                            "last_consulted_at": 1756339200,
                                            "updated_at": 1756252800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/pam-beesly",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/contacts/pam-beesly"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/contacts/{contact}/template-version": {
            "put": {
                "operationId": "contacts-template-version-update",
                "tags": [
                    "Contacts"
                ],
                "summary": "Move to another version",
                "description": "Put a contact on another published version of the template their page renders from.\n\nPublishing a new version of a template moves nobody. This is the only thing that does, and it moves one contact at a time, in either direction: forward onto what the template publishes now, or back onto a version it published before.\n\nNothing written on the record is touched. What was there is snapshotted first, so the move can be undone.\n\nWhat you may name is deliberately narrow: a published version of the template this contact already renders from. A draft, a version of another template, and a version of another account each answer 404 rather than 422, because it is an address for something that is not on offer rather than a bad field.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the contact lives in, named either by the readable name it reports as slug or by its id. Both answer.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "contact",
                        "in": "path",
                        "required": true,
                        "description": "The contact, named either by the readable name it reports as slug or by its id. Both answer. A readable name is rebuilt whenever the record is renamed, and the previous one stops answering, so a client that stores a reference stores the id. A name a record has released is never given to another. The contact has to be in the vault the path names: a contact of yours addressed through the wrong vault answers 404, the same as one that never existed. A contact absorbed by a merge answers 404 here, and the merge endpoints say what became of them.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "structure_version_id": {
                                        "type": "integer",
                                        "description": "The published version to move onto. Leave it out to move onto whatever that template publishes now, which is how a contact catches up after a template is republished."
                                    }
                                }
                            },
                            "example": {
                                "structure_version_id": 4
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The contact object as it now reads, on its new version. A contact belonging to somebody else, a version not on offer, or the wrong vault each answer 404 and the contact is left where it was.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The contact.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always contact. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "slug": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The readable name the contact is addressed by, built from the whole name above and unique within the vault. It keeps the alphabet the name is written in, so a name in Japanese is addressed in Japanese, sent as its own characters or percent encoded. It is not stable: correcting the name rebuilds it and the previous one stops answering, which is why a stored reference should be the id. Nothing lets you choose or edit it."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The name the contact is shown under: the formatted name of the way of writing it chosen for display, else its parts in the order it reads in. It is what the lists sort on, and it is built rather than stored, so it cannot be written directly."
                                                        },
                                                        "formatted_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The full name exactly as written for the way of writing it chosen for display, or null when that way is only parts."
                                                        },
                                                        "name_representations": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "Every way the current name is written: in its own script, transliterated into another, or as it is pronounced, in the order the owner put them. Every one of them finds the contact in a search. Nothing is transliterated for you.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One way of writing the name.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of this way of writing the name. Send it back to keep it when the list is replaced."
                                                                    },
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "written for the name in a script of its own, transliteration for the name carried into another script, phonetic for how it is pronounced."
                                                                    },
                                                                    "language": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "A BCP 47 language tag such as ko or ja, or null."
                                                                    },
                                                                    "script": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "An ISO 15924 script code such as Hang, Hani or Latn, or null."
                                                                    },
                                                                    "phonetic_system": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "For a pronunciation, the system it is written in, as the vCard PHONETIC parameter names it: ipa, piny, x-romaji, x-rr, x-other, or a token a device sent. Null for any other kind."
                                                                    },
                                                                    "formatted_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The full name exactly as it should appear, up to 255 characters, or null to build it from the parts. Always null for a pronunciation, which is written in its parts."
                                                                    },
                                                                    "prefix": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 50 characters, or null."
                                                                    },
                                                                    "given_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 255 characters, or null."
                                                                    },
                                                                    "additional_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Other given names, up to 255 characters, or null."
                                                                    },
                                                                    "family_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 255 characters, or null."
                                                                    },
                                                                    "suffix": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 50 characters, or null."
                                                                    },
                                                                    "name_order": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Either given_first or family_first, or null to leave it to the reader."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Where it stands in the list, from 1."
                                                                    },
                                                                    "is_display": {
                                                                        "type": [
                                                                            "boolean",
                                                                            "null"
                                                                        ],
                                                                        "description": "Whether this is the way the contact is shown under, in lists, titles, notifications and initials. Exactly one is, whenever the contact has a name."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "prefix": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What comes before the name, up to 50 characters, or null. Dr and Sir are prefixes."
                                                        },
                                                        "first_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The given name of the way of writing the name chosen for display, up to 255 characters, or null. Like the prefix, the middle name, the last name, the suffix and the name order, it is a copy read from that way of writing it."
                                                        },
                                                        "middle_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Up to 255 characters, or null."
                                                        },
                                                        "last_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The family name, up to 255 characters, or null."
                                                        },
                                                        "suffix": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What comes after the name, up to 50 characters, or null. Jr and PhD are suffixes."
                                                        },
                                                        "maiden_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Up to 255 characters, or null."
                                                        },
                                                        "nickname": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What this person is actually called, up to 255 characters, or null. It is searched as it was typed rather than folded, and it is what the whole name falls back to when no other part is set."
                                                        },
                                                        "name_order": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either given_first or family_first, or null to leave it to the reader. It is a fact about this person rather than a preference of yours, which is what lets a Japanese name keep its order in a list of western ones."
                                                        },
                                                        "initials": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The one or two letters drawn when the contact has no picture. Built from the name, so it cannot be written."
                                                        },
                                                        "avatar_colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The background those initials are drawn on, as a hex colour. It is chosen when the contact is written down and never changes afterwards, so somebody who has learnt to spot a face in a list does not have it move."
                                                        },
                                                        "avatar": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The picture, or null when the contact is drawn as its initials.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the file the picture was stored as. It is a file of the vault like any other, so it counts against your storage."
                                                                },
                                                                "url": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "Where the picture is served from. This address is served by the application and needs a signed in session rather than a token: no endpoint here streams a vault's files yet, and a document is as private as the record it sits on."
                                                                }
                                                            }
                                                        },
                                                        "is_favourite": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the contact sits at the top of the list."
                                                        },
                                                        "is_archived": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the contact has been put away. An archived contact is left out of every list. Reading this is possible here; changing it is not, because no screen offers the gesture either."
                                                        },
                                                        "is_partial": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the contact is somebody mentioned in a relationship and reduced to a first name. A partial contact is off every list until somebody fills them in, so it is listed by no filter at all."
                                                        },
                                                        "is_me": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether this contact represents you. Exactly one contact per vault is, it cannot be deleted, and nothing here hands the title to somebody else."
                                                        },
                                                        "age": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How old the contact is in whole years, on your current day in your time zone. Null when the birthday is not recorded, when its year or its month is unknown, or when its date lies in the future. Null too when the birthday field is sensitive and the key lacks the sensitive-fields ability. It is worked out on every read and never stored."
                                                        },
                                                        "next_birthday_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The next birthday as a date written Y-m-d, on or after your current day in your time zone, so it is today's date on the birthday itself. A birthday on 29 February falls on 28 February in a year without one. Null when the birthday is not recorded, when its month is unknown, or when the birthday field is sensitive and the key lacks the sensitive-fields ability."
                                                        },
                                                        "structure_version_id": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The published version of the template this contact renders from. It says what pages the contact has and what is written on them. Publishing a new version moves nobody: a contact stays on the version it points at until it is moved."
                                                        },
                                                        "template_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What that template is called, which is what the lists show beside a contact."
                                                        },
                                                        "categories": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The categories the contact holds, in the order of your list of contact categories. A category is a choice of that list held in any field of the template drawing on it. Empty when the contact holds none.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One category.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "The id of the category, which is what the list of contacts filters on."
                                                                    },
                                                                    "label": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the category is called, in the language of the request for a category the application supplied."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "last_life_event_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact last took part in a life event, as a count of seconds since 1970, or null when they never have. It says nothing about whether you were there."
                                                        },
                                                        "last_interaction_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The Last in touch date: the day of the latest life event the contact took part in that has already happened and whose nature has updates_last_in_touch, as a count of seconds since 1970, or null when there is none. This is what Last in touch and Last spoke read."
                                                        },
                                                        "last_consulted_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact was last consulted on their own, as a count of seconds since 1970, or null when they never have been: their page opened in Monica, the contact read through this endpoint, or read by an assistant connected over MCP. Listing contacts does not change it."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact was written down, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The page of the contact in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "contact",
                                        "id": "c4a1f7b2-8e36-4d59-b0a7-2f5c9d81e364",
                                        "attributes": {
                                            "slug": "pam-beesly",
                                            "name": "Pam Beesly",
                                            "formatted_name": null,
                                            "name_representations": [
                                                {
                                                    "id": "0e6d3b1a-52c7-4f9e-8a41-b7d2c96f0e13",
                                                    "kind": "written",
                                                    "language": null,
                                                    "script": null,
                                                    "phonetic_system": null,
                                                    "formatted_name": null,
                                                    "prefix": null,
                                                    "given_name": "Pam",
                                                    "additional_name": null,
                                                    "family_name": "Beesly",
                                                    "suffix": null,
                                                    "name_order": "given_first",
                                                    "position": 1,
                                                    "is_display": true
                                                }
                                            ],
                                            "prefix": null,
                                            "first_name": "Pam",
                                            "middle_name": null,
                                            "last_name": "Beesly",
                                            "suffix": null,
                                            "maiden_name": null,
                                            "nickname": "Pammy",
                                            "name_order": "given_first",
                                            "initials": "PB",
                                            "avatar_colour": "#0ea5e9",
                                            "avatar": {
                                                "id": "3f6c1d90-4b27-4e85-a1c3-9d720f5b8e46",
                                                "url": "https://my.monicahq.com/api/v1/vaults/9d4f1c2e-7b3a-4f88-9a2d-6c1e5b0f7a31/files/3f6c1d90-4b27-4e85-a1c3-9d720f5b8e46"
                                            },
                                            "is_favourite": true,
                                            "is_archived": false,
                                            "is_partial": false,
                                            "is_me": false,
                                            "age": 36,
                                            "next_birthday_on": "2026-03-14",
                                            "structure_version_id": 4,
                                            "template_name": "Default contact",
                                            "categories": [
                                                {
                                                    "id": 12,
                                                    "label": "Colleague"
                                                }
                                            ],
                                            "last_life_event_at": null,
                                            "created_at": 1756252800,
                                            "last_interaction_at": null,
                                            "last_consulted_at": 1756339200,
                                            "updated_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/pam-beesly",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/contacts/pam-beesly"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/contacts/{contact}/sections/{section}": {
            "put": {
                "operationId": "contacts-sections-update",
                "tags": [
                    "Contacts"
                ],
                "summary": "Save a section of a contact",
                "description": "Write every field of one section of a contact's page in one call, the way the page saves it.\n\nThe section is named by its id, and it has to be one the contact's template version places. A field left out of fields keeps its value, and a field sent as null is emptied. A file cannot be sent here.\n\nA multiple choice field also takes new_choices, wordings to add to its list as the contact is saved. A wording naming a choice the list holds, whatever its case and the spaces around it, picks that choice rather than adding a second one. Nothing is added unless the whole section is saved.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the contact lives in, named either by the readable name it reports as slug or by its id. Both answer.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "contact",
                        "in": "path",
                        "required": true,
                        "description": "The contact, named either by the readable name it reports as slug or by its id. Both answer. A readable name is rebuilt whenever the record is renamed, and the previous one stops answering, so a client that stores a reference stores the id. A name a record has released is never given to another. The contact has to be in the vault the path names: a contact of yours addressed through the wrong vault answers 404, the same as one that never existed. A contact absorbed by a merge answers 404 here, and the merge endpoints say what became of them.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "section",
                        "in": "path",
                        "required": true,
                        "description": "The id of the section.",
                        "schema": {
                            "type": "integer"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "fields": {
                                        "type": "object",
                                        "description": "The values, keyed by the id of their field. A multiple choice field takes an array of the ids of the choices."
                                    },
                                    "labels": {
                                        "type": "object",
                                        "description": "For an email, a phone or an address, the id of the label picked beside it, keyed by field."
                                    },
                                    "label_wordings": {
                                        "type": "object",
                                        "description": "The wording typed for the open label, up to 255 characters, keyed by field."
                                    },
                                    "year_is_unknown": {
                                        "type": "object",
                                        "description": "For a date, true when its year is not known, keyed by field."
                                    },
                                    "month_is_unknown": {
                                        "type": "object",
                                        "description": "For a date, true when its month is not known either, keyed by field."
                                    },
                                    "new_choices": {
                                        "type": "object",
                                        "description": "For a multiple choice field, an array of wordings to find or add to its list, each up to 255 characters, keyed by field."
                                    }
                                }
                            },
                            "example": {
                                "fields": {
                                    "118": [
                                        12
                                    ]
                                },
                                "new_choices": {
                                    "118": [
                                        "Finer Things Club"
                                    ]
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The contact object as it now reads. A contact, a vault or a section belonging to somebody else answers 404. A wording naming a choice that is no longer offered, and a list that does not take choices of its own, answer 422 on fields, and nothing is written.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The contact.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always contact. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "slug": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The readable name the contact is addressed by, built from the whole name above and unique within the vault. It keeps the alphabet the name is written in, so a name in Japanese is addressed in Japanese, sent as its own characters or percent encoded. It is not stable: correcting the name rebuilds it and the previous one stops answering, which is why a stored reference should be the id. Nothing lets you choose or edit it."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The name the contact is shown under: the formatted name of the way of writing it chosen for display, else its parts in the order it reads in. It is what the lists sort on, and it is built rather than stored, so it cannot be written directly."
                                                        },
                                                        "formatted_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The full name exactly as written for the way of writing it chosen for display, or null when that way is only parts."
                                                        },
                                                        "name_representations": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "Every way the current name is written: in its own script, transliterated into another, or as it is pronounced, in the order the owner put them. Every one of them finds the contact in a search. Nothing is transliterated for you.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One way of writing the name.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of this way of writing the name. Send it back to keep it when the list is replaced."
                                                                    },
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "written for the name in a script of its own, transliteration for the name carried into another script, phonetic for how it is pronounced."
                                                                    },
                                                                    "language": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "A BCP 47 language tag such as ko or ja, or null."
                                                                    },
                                                                    "script": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "An ISO 15924 script code such as Hang, Hani or Latn, or null."
                                                                    },
                                                                    "phonetic_system": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "For a pronunciation, the system it is written in, as the vCard PHONETIC parameter names it: ipa, piny, x-romaji, x-rr, x-other, or a token a device sent. Null for any other kind."
                                                                    },
                                                                    "formatted_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The full name exactly as it should appear, up to 255 characters, or null to build it from the parts. Always null for a pronunciation, which is written in its parts."
                                                                    },
                                                                    "prefix": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 50 characters, or null."
                                                                    },
                                                                    "given_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 255 characters, or null."
                                                                    },
                                                                    "additional_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Other given names, up to 255 characters, or null."
                                                                    },
                                                                    "family_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 255 characters, or null."
                                                                    },
                                                                    "suffix": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Up to 50 characters, or null."
                                                                    },
                                                                    "name_order": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Either given_first or family_first, or null to leave it to the reader."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Where it stands in the list, from 1."
                                                                    },
                                                                    "is_display": {
                                                                        "type": [
                                                                            "boolean",
                                                                            "null"
                                                                        ],
                                                                        "description": "Whether this is the way the contact is shown under, in lists, titles, notifications and initials. Exactly one is, whenever the contact has a name."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "prefix": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What comes before the name, up to 50 characters, or null. Dr and Sir are prefixes."
                                                        },
                                                        "first_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The given name of the way of writing the name chosen for display, up to 255 characters, or null. Like the prefix, the middle name, the last name, the suffix and the name order, it is a copy read from that way of writing it."
                                                        },
                                                        "middle_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Up to 255 characters, or null."
                                                        },
                                                        "last_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The family name, up to 255 characters, or null."
                                                        },
                                                        "suffix": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What comes after the name, up to 50 characters, or null. Jr and PhD are suffixes."
                                                        },
                                                        "maiden_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Up to 255 characters, or null."
                                                        },
                                                        "nickname": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What this person is actually called, up to 255 characters, or null. It is searched as it was typed rather than folded, and it is what the whole name falls back to when no other part is set."
                                                        },
                                                        "name_order": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either given_first or family_first, or null to leave it to the reader. It is a fact about this person rather than a preference of yours, which is what lets a Japanese name keep its order in a list of western ones."
                                                        },
                                                        "initials": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The one or two letters drawn when the contact has no picture. Built from the name, so it cannot be written."
                                                        },
                                                        "avatar_colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The background those initials are drawn on, as a hex colour. It is chosen when the contact is written down and never changes afterwards, so somebody who has learnt to spot a face in a list does not have it move."
                                                        },
                                                        "avatar": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The picture, or null when the contact is drawn as its initials.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the file the picture was stored as. It is a file of the vault like any other, so it counts against your storage."
                                                                },
                                                                "url": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "Where the picture is served from. This address is served by the application and needs a signed in session rather than a token: no endpoint here streams a vault's files yet, and a document is as private as the record it sits on."
                                                                }
                                                            }
                                                        },
                                                        "is_favourite": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the contact sits at the top of the list."
                                                        },
                                                        "is_archived": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the contact has been put away. An archived contact is left out of every list. Reading this is possible here; changing it is not, because no screen offers the gesture either."
                                                        },
                                                        "is_partial": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the contact is somebody mentioned in a relationship and reduced to a first name. A partial contact is off every list until somebody fills them in, so it is listed by no filter at all."
                                                        },
                                                        "is_me": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether this contact represents you. Exactly one contact per vault is, it cannot be deleted, and nothing here hands the title to somebody else."
                                                        },
                                                        "age": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How old the contact is in whole years, on your current day in your time zone. Null when the birthday is not recorded, when its year or its month is unknown, or when its date lies in the future. Null too when the birthday field is sensitive and the key lacks the sensitive-fields ability. It is worked out on every read and never stored."
                                                        },
                                                        "next_birthday_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The next birthday as a date written Y-m-d, on or after your current day in your time zone, so it is today's date on the birthday itself. A birthday on 29 February falls on 28 February in a year without one. Null when the birthday is not recorded, when its month is unknown, or when the birthday field is sensitive and the key lacks the sensitive-fields ability."
                                                        },
                                                        "structure_version_id": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The published version of the template this contact renders from. It says what pages the contact has and what is written on them. Publishing a new version moves nobody: a contact stays on the version it points at until it is moved."
                                                        },
                                                        "template_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What that template is called, which is what the lists show beside a contact."
                                                        },
                                                        "categories": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The categories the contact holds, in the order of your list of contact categories. A category is a choice of that list held in any field of the template drawing on it. Empty when the contact holds none.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One category.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "The id of the category, which is what the list of contacts filters on."
                                                                    },
                                                                    "label": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the category is called, in the language of the request for a category the application supplied."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "last_life_event_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact last took part in a life event, as a count of seconds since 1970, or null when they never have. It says nothing about whether you were there."
                                                        },
                                                        "last_interaction_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The Last in touch date: the day of the latest life event the contact took part in that has already happened and whose nature has updates_last_in_touch, as a count of seconds since 1970, or null when there is none. This is what Last in touch and Last spoke read."
                                                        },
                                                        "last_consulted_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact was last consulted on their own, as a count of seconds since 1970, or null when they never have been: their page opened in Monica, the contact read through this endpoint, or read by an assistant connected over MCP. Listing contacts does not change it."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact was written down, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the contact last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The page of the contact in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "contact",
                                        "id": "c4a1f7b2-8e36-4d59-b0a7-2f5c9d81e364",
                                        "attributes": {
                                            "slug": "pam-beesly",
                                            "name": "Pam Beesly",
                                            "formatted_name": null,
                                            "name_representations": [
                                                {
                                                    "id": "0e6d3b1a-52c7-4f9e-8a41-b7d2c96f0e13",
                                                    "kind": "written",
                                                    "language": null,
                                                    "script": null,
                                                    "phonetic_system": null,
                                                    "formatted_name": null,
                                                    "prefix": null,
                                                    "given_name": "Pam",
                                                    "additional_name": null,
                                                    "family_name": "Beesly",
                                                    "suffix": null,
                                                    "name_order": "given_first",
                                                    "position": 1,
                                                    "is_display": true
                                                }
                                            ],
                                            "prefix": null,
                                            "first_name": "Pam",
                                            "middle_name": null,
                                            "last_name": "Beesly",
                                            "suffix": null,
                                            "maiden_name": null,
                                            "nickname": "Pammy",
                                            "name_order": "given_first",
                                            "initials": "PB",
                                            "avatar_colour": "#0ea5e9",
                                            "avatar": {
                                                "id": "3f6c1d90-4b27-4e85-a1c3-9d720f5b8e46",
                                                "url": "https://my.monicahq.com/api/v1/vaults/9d4f1c2e-7b3a-4f88-9a2d-6c1e5b0f7a31/files/3f6c1d90-4b27-4e85-a1c3-9d720f5b8e46"
                                            },
                                            "is_favourite": true,
                                            "is_archived": false,
                                            "is_partial": false,
                                            "is_me": false,
                                            "age": 36,
                                            "next_birthday_on": "2026-03-14",
                                            "structure_version_id": 4,
                                            "template_name": "Default contact",
                                            "categories": [
                                                {
                                                    "id": 12,
                                                    "label": "Colleague"
                                                },
                                                {
                                                    "id": 31,
                                                    "label": "Finer Things Club"
                                                }
                                            ],
                                            "last_life_event_at": null,
                                            "created_at": 1756252800,
                                            "last_interaction_at": null,
                                            "last_consulted_at": 1756339200,
                                            "updated_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/pam-beesly",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/contacts/pam-beesly"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/contact-categories": {
            "get": {
                "operationId": "contact-categories-index",
                "tags": [
                    "Contacts"
                ],
                "summary": "List the categories held in a vault",
                "description": "List the categories somebody in a vault holds, with how many people hold each, which is what the people screen offers to narrow its list with.\n\nA category is a choice of your list of contact categories, which every vault of the account shares. Only the categories somebody in the vault holds are listed, in the order of the list, and a category that is no longer offered is still listed while somebody holds it. A person holding a category in two fields counts once.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the contact lives in, named either by the readable name it reports as slug or by its id. Both answer.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "filter",
                        "in": "query",
                        "required": false,
                        "description": "Count only the people of one grouping: all, favourites or names-only.",
                        "schema": {
                            "type": "string",
                            "default": "all"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Every category held in the vault, with how many people hold it. A vault belonging to somebody else answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The categories, in the order of the list.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One category.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always contact_category."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "integer",
                                                            "null"
                                                        ],
                                                        "description": "The id of the category, which the list of contacts filters on."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "What the category is.",
                                                        "properties": {
                                                            "label": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the category is called."
                                                            },
                                                            "is_active": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "False when the category is no longer offered. It stays on the people who hold it."
                                                            },
                                                            "contacts_count": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How many people of the vault hold it."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "contact_category",
                                            "id": 12,
                                            "attributes": {
                                                "label": "Colleague",
                                                "is_active": true,
                                                "contacts_count": 4
                                            }
                                        },
                                        {
                                            "type": "contact_category",
                                            "id": 31,
                                            "attributes": {
                                                "label": "Finer Things Club",
                                                "is_active": true,
                                                "contacts_count": 2
                                            }
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "contact-categories-index-query",
                "tags": [
                    "Contacts"
                ],
                "summary": "List the categories held in a vault",
                "description": "List the categories somebody in a vault holds, with how many people hold each, which is what the people screen offers to narrow its list with.\n\nA category is a choice of your list of contact categories, which every vault of the account shares. Only the categories somebody in the vault holds are listed, in the order of the list, and a category that is no longer offered is still listed while somebody holds it. A person holding a category in two fields counts once.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the contact lives in, named either by the readable name it reports as slug or by its id. Both answer.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "filter": {
                                        "type": "string",
                                        "default": "all",
                                        "description": "Count only the people of one grouping: all, favourites or names-only."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Every category held in the vault, with how many people hold it. A vault belonging to somebody else answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The categories, in the order of the list.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One category.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always contact_category."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "integer",
                                                            "null"
                                                        ],
                                                        "description": "The id of the category, which the list of contacts filters on."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "What the category is.",
                                                        "properties": {
                                                            "label": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the category is called."
                                                            },
                                                            "is_active": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "False when the category is no longer offered. It stays on the people who hold it."
                                                            },
                                                            "contacts_count": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How many people of the vault hold it."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "contact_category",
                                            "id": 12,
                                            "attributes": {
                                                "label": "Colleague",
                                                "is_active": true,
                                                "contacts_count": 4
                                            }
                                        },
                                        {
                                            "type": "contact_category",
                                            "id": 31,
                                            "attributes": {
                                                "label": "Finer Things Club",
                                                "is_active": true,
                                                "contacts_count": 2
                                            }
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/contact-list-columns": {
            "get": {
                "operationId": "contact-list-columns-show",
                "tags": [
                    "Contacts"
                ],
                "summary": "Get the columns of the people screen",
                "description": "Read which columns the people screen of a vault shows beside the name, what they are called and in what order.\n\nA vault that never chose answers with the defaults: email, phone and last spoke shown, the template hidden. The meta says which of the two you are reading.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the contact lives in, named either by the readable name it reports as slug or by its id. Both answer.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Every column after the name. A vault belonging to somebody else answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "Every column after the name, in the order the screen shows them.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One column.",
                                                "properties": {
                                                    "source": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "What the column shows: nickname, email, phone, birthday, template, last-spoke, added, or field for a field of a template. The name is not a column: it is always shown, always first, and never listed."
                                                    },
                                                    "section": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "format": "uuid",
                                                        "description": "For a field, the id of the section holding it, or null. A section can sit in several templates, so one column covers every template placing it, in every version."
                                                    },
                                                    "field_key": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "For a field, its key inside the section, or null."
                                                    },
                                                    "heading": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The heading somebody wrote, or null for the default."
                                                    },
                                                    "default_heading": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "What the column is called when nobody renamed it, in the language of the request. Read only."
                                                    },
                                                    "is_visible": {
                                                        "type": [
                                                            "boolean",
                                                            "null"
                                                        ],
                                                        "description": "Whether the screen shows the column. A hidden column keeps its place and its heading."
                                                    },
                                                    "is_supplied": {
                                                        "type": [
                                                            "boolean",
                                                            "null"
                                                        ],
                                                        "description": "False when no active contact template carries the field any more. The column is kept, and the list leaves it out until a template carries the field again. Read only."
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "source": "field",
                                            "section": "5e8b2c17-9f04-4d6a-b3e1-7a20c4d95f18",
                                            "field_key": "company",
                                            "heading": "Employer",
                                            "default_heading": "Company",
                                            "is_visible": true,
                                            "is_supplied": true
                                        },
                                        {
                                            "source": "email",
                                            "section": null,
                                            "field_key": null,
                                            "heading": null,
                                            "default_heading": "Email",
                                            "is_visible": true,
                                            "is_supplied": true
                                        },
                                        {
                                            "source": "template",
                                            "section": null,
                                            "field_key": null,
                                            "heading": null,
                                            "default_heading": "Template",
                                            "is_visible": false,
                                            "is_supplied": true
                                        }
                                    ],
                                    "meta": {
                                        "is_default": false
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "contact-list-columns-show-query",
                "tags": [
                    "Contacts"
                ],
                "summary": "Get the columns of the people screen",
                "description": "Read which columns the people screen of a vault shows beside the name, what they are called and in what order.\n\nA vault that never chose answers with the defaults: email, phone and last spoke shown, the template hidden. The meta says which of the two you are reading.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the contact lives in, named either by the readable name it reports as slug or by its id. Both answer.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Every column after the name. A vault belonging to somebody else answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "Every column after the name, in the order the screen shows them.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One column.",
                                                "properties": {
                                                    "source": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "What the column shows: nickname, email, phone, birthday, template, last-spoke, added, or field for a field of a template. The name is not a column: it is always shown, always first, and never listed."
                                                    },
                                                    "section": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "format": "uuid",
                                                        "description": "For a field, the id of the section holding it, or null. A section can sit in several templates, so one column covers every template placing it, in every version."
                                                    },
                                                    "field_key": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "For a field, its key inside the section, or null."
                                                    },
                                                    "heading": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The heading somebody wrote, or null for the default."
                                                    },
                                                    "default_heading": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "What the column is called when nobody renamed it, in the language of the request. Read only."
                                                    },
                                                    "is_visible": {
                                                        "type": [
                                                            "boolean",
                                                            "null"
                                                        ],
                                                        "description": "Whether the screen shows the column. A hidden column keeps its place and its heading."
                                                    },
                                                    "is_supplied": {
                                                        "type": [
                                                            "boolean",
                                                            "null"
                                                        ],
                                                        "description": "False when no active contact template carries the field any more. The column is kept, and the list leaves it out until a template carries the field again. Read only."
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "source": "field",
                                            "section": "5e8b2c17-9f04-4d6a-b3e1-7a20c4d95f18",
                                            "field_key": "company",
                                            "heading": "Employer",
                                            "default_heading": "Company",
                                            "is_visible": true,
                                            "is_supplied": true
                                        },
                                        {
                                            "source": "email",
                                            "section": null,
                                            "field_key": null,
                                            "heading": null,
                                            "default_heading": "Email",
                                            "is_visible": true,
                                            "is_supplied": true
                                        },
                                        {
                                            "source": "template",
                                            "section": null,
                                            "field_key": null,
                                            "heading": null,
                                            "default_heading": "Template",
                                            "is_visible": false,
                                            "is_supplied": true
                                        }
                                    ],
                                    "meta": {
                                        "is_default": false
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "put": {
                "operationId": "contact-list-columns-update",
                "tags": [
                    "Contacts"
                ],
                "summary": "Choose the columns of the people screen",
                "description": "Choose the columns the people screen of a vault shows, in one call.\n\nThis changes what the screen shows and nothing written on any contact. It is written to your account log.\n\nAsking for the same column twice, or for a field no template carries, answers 422 and leaves the columns as they were.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the contact lives in, named either by the readable name it reports as slug or by its id. Both answer.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "columns": {
                                        "type": "array",
                                        "description": "Every column after the name, in the order the screen shows them. Sent, it replaces whatever the vault held; left out, the columns stay as they are. An empty array puts the defaults back; to show the name alone, send the columns with is_visible false.",
                                        "properties": {
                                            "*": {
                                                "type": "object",
                                                "properties": {
                                                    "source": {
                                                        "type": "string",
                                                        "description": "One of the sources listed above. The same source may appear once, and the same field once."
                                                    },
                                                    "section": {
                                                        "type": "string",
                                                        "format": "uuid",
                                                        "description": "Required when the source is field: the section holding it, which has to be one of yours."
                                                    },
                                                    "field_key": {
                                                        "type": "string",
                                                        "description": "Required when the source is field, up to 64 characters. The field has to be carried by the published version of one of your active contact templates, unless the vault already shows it, which lets a column no template supplies any more be kept."
                                                    },
                                                    "heading": {
                                                        "type": "string",
                                                        "description": "Up to 255 characters. Empty or null keeps the default heading."
                                                    },
                                                    "is_visible": {
                                                        "type": "boolean",
                                                        "description": "Whether the screen shows the column."
                                                    }
                                                },
                                                "required": [
                                                    "source",
                                                    "is_visible"
                                                ]
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The columns as they now stand. A vault or a section belonging to somebody else answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "Every column after the name, in the order the screen shows them.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One column.",
                                                "properties": {
                                                    "source": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "What the column shows: nickname, email, phone, birthday, template, last-spoke, added, or field for a field of a template. The name is not a column: it is always shown, always first, and never listed."
                                                    },
                                                    "section": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "format": "uuid",
                                                        "description": "For a field, the id of the section holding it, or null. A section can sit in several templates, so one column covers every template placing it, in every version."
                                                    },
                                                    "field_key": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "For a field, its key inside the section, or null."
                                                    },
                                                    "heading": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The heading somebody wrote, or null for the default."
                                                    },
                                                    "default_heading": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "What the column is called when nobody renamed it, in the language of the request. Read only."
                                                    },
                                                    "is_visible": {
                                                        "type": [
                                                            "boolean",
                                                            "null"
                                                        ],
                                                        "description": "Whether the screen shows the column. A hidden column keeps its place and its heading."
                                                    },
                                                    "is_supplied": {
                                                        "type": [
                                                            "boolean",
                                                            "null"
                                                        ],
                                                        "description": "False when no active contact template carries the field any more. The column is kept, and the list leaves it out until a template carries the field again. Read only."
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "source": "field",
                                            "section": "5e8b2c17-9f04-4d6a-b3e1-7a20c4d95f18",
                                            "field_key": "company",
                                            "heading": "Employer",
                                            "default_heading": "Company",
                                            "is_visible": true,
                                            "is_supplied": true
                                        },
                                        {
                                            "source": "email",
                                            "section": null,
                                            "field_key": null,
                                            "heading": null,
                                            "default_heading": "Email",
                                            "is_visible": true,
                                            "is_supplied": true
                                        },
                                        {
                                            "source": "template",
                                            "section": null,
                                            "field_key": null,
                                            "heading": null,
                                            "default_heading": "Template",
                                            "is_visible": false,
                                            "is_supplied": true
                                        }
                                    ],
                                    "meta": {
                                        "is_default": false
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/entity-types": {
            "get": {
                "operationId": "entity-types-index",
                "tags": [
                    "Kinds of record"
                ],
                "summary": "List entity types",
                "description": "List the kinds of object your account invented, in the order you arranged them.\n\nA type is the noun you reached for when nothing the product ships with fits: Animal, Company, Recipe, Wine bottle. It belongs to your account rather than to one vault, so a type declared once is visible in every vault you hold.\n\nThe order is the one you gave them, which is the order they are listed in down the side of a vault. It is not the order they were declared in. Types that may no longer be filed under are listed with the rest, because one that is off is meant to be found again and switched back on.\n\nA deleted type is never listed. An account that invented nothing answers with an empty list rather than an error, since that is the state every account starts in.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to answer with.",
                        "schema": {
                            "type": "integer",
                            "default": 1
                        }
                    },
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "How many types one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused.",
                        "schema": {
                            "type": "integer",
                            "default": 25
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of entity type objects, and how many there are in all.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The types on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One type.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always entity_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "slug": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "How the type is addressed in the application itself, in lower case letters, numbers and dashes. It is settled when the type is declared and never rebuilt, so a link that already went out keeps working through any rename. Use it to build a browser link; use the id for every call here."
                                                            },
                                                            "name_singular": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What one of these is called: Animal, Company, Recipe. Up to 255 characters. Reduced to plain text when it was written down, so no markup survives here."
                                                            },
                                                            "name_plural": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What several of them are called. Stored rather than derived from the singular, because a plural derived in English is wrong in most other languages."
                                                            },
                                                            "description": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the type is for, up to 65535 characters, or null when nobody said."
                                                            },
                                                            "icon": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "One of profile, logs, security, preferences, key, device, info, life event, mail, sun, moon or check. It is a name rather than a drawing, so the picture lives in the application and the type stores a word."
                                                            },
                                                            "colour": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Exactly one of #3f5fd0, #4f8a49, #9a6a24, #9a3f2b, #5d5f96 or #1d1d20, written in lower case. It is how types are told apart at a glance in the navigation, and it is decoration: nothing depends on it."
                                                            },
                                                            "position": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "Where the type sits in the vault navigation, counting from 1. It is the order you arranged, and it is the order the list endpoint answers in. Types that may no longer be filed under are numbered along with the rest, so one switched back on finds the place it had."
                                                            },
                                                            "is_active": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether new records may still be filed under the type. False stops the button that adds another and touches nothing already filed: every record stays readable and stays editable."
                                                            },
                                                            "entity_count": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How many records of this kind exist, across every vault of your account. It is a running count kept as records are written down and deleted, rather than something counted when you ask, and it is what decides whether the type may be deleted."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the type was declared, as a count of seconds since 1970 rather than a written date."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "entity_type",
                                            "id": "4c2b9f10-5e37-4a6d-8b91-0f7c3d2a8e64",
                                            "attributes": {
                                                "slug": "animal",
                                                "name_singular": "Animal",
                                                "name_plural": "Animals",
                                                "description": "Every creature the family keeps.",
                                                "icon": "profile",
                                                "colour": "#4f8a49",
                                                "position": 1,
                                                "is_active": true,
                                                "entity_count": 12,
                                                "created_at": 1756252800,
                                                "updated_at": 1756339200
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/entity-types/4c2b9f10-5e37-4a6d-8b91-0f7c3d2a8e64"
                                            }
                                        },
                                        {
                                            "type": "entity_type",
                                            "id": "e8a51d73-9c04-4b28-a6f5-31b7e0c4d925",
                                            "attributes": {
                                                "slug": "wine-bottle",
                                                "name_singular": "Wine bottle",
                                                "name_plural": "Wine bottles",
                                                "description": null,
                                                "icon": "key",
                                                "colour": "#9a6a24",
                                                "position": 2,
                                                "is_active": false,
                                                "entity_count": 0,
                                                "created_at": 1756166400,
                                                "updated_at": 1756166400
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/entity-types/e8a51d73-9c04-4b28-a6f5-31b7e0c4d925"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 2
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "entity-types-index-query",
                "tags": [
                    "Kinds of record"
                ],
                "summary": "List entity types",
                "description": "List the kinds of object your account invented, in the order you arranged them.\n\nA type is the noun you reached for when nothing the product ships with fits: Animal, Company, Recipe, Wine bottle. It belongs to your account rather than to one vault, so a type declared once is visible in every vault you hold.\n\nThe order is the one you gave them, which is the order they are listed in down the side of a vault. It is not the order they were declared in. Types that may no longer be filed under are listed with the rest, because one that is off is meant to be found again and switched back on.\n\nA deleted type is never listed. An account that invented nothing answers with an empty list rather than an error, since that is the state every account starts in.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "page": {
                                        "type": "integer",
                                        "default": 1,
                                        "description": "Which page to answer with."
                                    },
                                    "per_page": {
                                        "type": "integer",
                                        "default": 25,
                                        "description": "How many types one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "A page of entity type objects, and how many there are in all.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The types on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One type.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always entity_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "slug": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "How the type is addressed in the application itself, in lower case letters, numbers and dashes. It is settled when the type is declared and never rebuilt, so a link that already went out keeps working through any rename. Use it to build a browser link; use the id for every call here."
                                                            },
                                                            "name_singular": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What one of these is called: Animal, Company, Recipe. Up to 255 characters. Reduced to plain text when it was written down, so no markup survives here."
                                                            },
                                                            "name_plural": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What several of them are called. Stored rather than derived from the singular, because a plural derived in English is wrong in most other languages."
                                                            },
                                                            "description": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the type is for, up to 65535 characters, or null when nobody said."
                                                            },
                                                            "icon": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "One of profile, logs, security, preferences, key, device, info, life event, mail, sun, moon or check. It is a name rather than a drawing, so the picture lives in the application and the type stores a word."
                                                            },
                                                            "colour": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Exactly one of #3f5fd0, #4f8a49, #9a6a24, #9a3f2b, #5d5f96 or #1d1d20, written in lower case. It is how types are told apart at a glance in the navigation, and it is decoration: nothing depends on it."
                                                            },
                                                            "position": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "Where the type sits in the vault navigation, counting from 1. It is the order you arranged, and it is the order the list endpoint answers in. Types that may no longer be filed under are numbered along with the rest, so one switched back on finds the place it had."
                                                            },
                                                            "is_active": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether new records may still be filed under the type. False stops the button that adds another and touches nothing already filed: every record stays readable and stays editable."
                                                            },
                                                            "entity_count": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How many records of this kind exist, across every vault of your account. It is a running count kept as records are written down and deleted, rather than something counted when you ask, and it is what decides whether the type may be deleted."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the type was declared, as a count of seconds since 1970 rather than a written date."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "entity_type",
                                            "id": "4c2b9f10-5e37-4a6d-8b91-0f7c3d2a8e64",
                                            "attributes": {
                                                "slug": "animal",
                                                "name_singular": "Animal",
                                                "name_plural": "Animals",
                                                "description": "Every creature the family keeps.",
                                                "icon": "profile",
                                                "colour": "#4f8a49",
                                                "position": 1,
                                                "is_active": true,
                                                "entity_count": 12,
                                                "created_at": 1756252800,
                                                "updated_at": 1756339200
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/entity-types/4c2b9f10-5e37-4a6d-8b91-0f7c3d2a8e64"
                                            }
                                        },
                                        {
                                            "type": "entity_type",
                                            "id": "e8a51d73-9c04-4b28-a6f5-31b7e0c4d925",
                                            "attributes": {
                                                "slug": "wine-bottle",
                                                "name_singular": "Wine bottle",
                                                "name_plural": "Wine bottles",
                                                "description": null,
                                                "icon": "key",
                                                "colour": "#9a6a24",
                                                "position": 2,
                                                "is_active": false,
                                                "entity_count": 0,
                                                "created_at": 1756166400,
                                                "updated_at": 1756166400
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/entity-types/e8a51d73-9c04-4b28-a6f5-31b7e0c4d925"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 2
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "post": {
                "operationId": "entity-types-create",
                "tags": [
                    "Kinds of record"
                ],
                "summary": "Create a kind of record",
                "description": "Declare a kind of object your account wants to keep, when nothing the product ships with fits.\n\nThis writes down the noun and nothing else. What one of its records holds is described separately, by a template, so a type can exist for a while with nothing to show. The type goes at the end of your navigation.\n\nBoth names are asked for rather than one being made from the other, because a plural derived in English is wrong in most other languages.\n\nThe slug is settled here and never rebuilt afterwards. Choose it, and what you send is cleaned the same way a derived one is, so nothing can put a space or an accent in an address. Say nothing, and it is made from the singular name. A slug already taken in your account is refused, and a type you deleted does not release the one it had, so a link that went out cannot later land on something else.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name_singular": {
                                        "type": "string",
                                        "description": "What one of these is called. Up to 255 characters. Markup and surrounding blank space are stripped."
                                    },
                                    "name_plural": {
                                        "type": "string",
                                        "description": "What several of them are called. Up to 255 characters."
                                    },
                                    "description": {
                                        "type": "string",
                                        "description": "What the type is for. Up to 65535 characters. Absent, empty or null all mean it has none."
                                    },
                                    "icon": {
                                        "type": "string",
                                        "default": "profile",
                                        "description": "One of profile, logs, security, preferences, key, device, info, life event, mail, sun, moon or check. Absent means profile."
                                    },
                                    "colour": {
                                        "type": "string",
                                        "default": "#3f5fd0",
                                        "description": "Exactly one of #3f5fd0, #4f8a49, #9a6a24, #9a3f2b, #5d5f96 or #1d1d20, written in lower case. Absent means #3f5fd0."
                                    },
                                    "is_active": {
                                        "type": "boolean",
                                        "default": true,
                                        "description": "Whether records may be filed under the type straight away. Absent means true. Send false to declare a type before anybody is meant to use it."
                                    },
                                    "slug": {
                                        "type": "string",
                                        "description": "How the type is addressed in the application itself: lower case letters, numbers and single dashes, up to 64 characters. Absent means one made from the singular name. A slug already taken in your account is refused, and that counts the slugs of types you have deleted."
                                    }
                                },
                                "required": [
                                    "name_singular",
                                    "name_plural"
                                ]
                            },
                            "example": {
                                "name_singular": "Animal",
                                "name_plural": "Animals",
                                "description": "Every creature the family keeps.",
                                "slug": "animal"
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The new entity type object. Keep its id: every other call here names the type by it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The type.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always entity_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "slug": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How the type is addressed in the application itself, in lower case letters, numbers and dashes. It is settled when the type is declared and never rebuilt, so a link that already went out keeps working through any rename. Use it to build a browser link; use the id for every call here."
                                                        },
                                                        "name_singular": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What one of these is called: Animal, Company, Recipe. Up to 255 characters. Reduced to plain text when it was written down, so no markup survives here."
                                                        },
                                                        "name_plural": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What several of them are called. Stored rather than derived from the singular, because a plural derived in English is wrong in most other languages."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the type is for, up to 65535 characters, or null when nobody said."
                                                        },
                                                        "icon": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of profile, logs, security, preferences, key, device, info, life event, mail, sun, moon or check. It is a name rather than a drawing, so the picture lives in the application and the type stores a word."
                                                        },
                                                        "colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Exactly one of #3f5fd0, #4f8a49, #9a6a24, #9a3f2b, #5d5f96 or #1d1d20, written in lower case. It is how types are told apart at a glance in the navigation, and it is decoration: nothing depends on it."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the type sits in the vault navigation, counting from 1. It is the order you arranged, and it is the order the list endpoint answers in. Types that may no longer be filed under are numbered along with the rest, so one switched back on finds the place it had."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether new records may still be filed under the type. False stops the button that adds another and touches nothing already filed: every record stays readable and stays editable."
                                                        },
                                                        "entity_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many records of this kind exist, across every vault of your account. It is a running count kept as records are written down and deleted, rather than something counted when you ask, and it is what decides whether the type may be deleted."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the type was declared, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "entity_type",
                                        "id": "4c2b9f10-5e37-4a6d-8b91-0f7c3d2a8e64",
                                        "attributes": {
                                            "slug": "animal",
                                            "name_singular": "Animal",
                                            "name_plural": "Animals",
                                            "description": "Every creature the family keeps.",
                                            "icon": "profile",
                                            "colour": "#4f8a49",
                                            "position": 1,
                                            "is_active": true,
                                            "entity_count": 12,
                                            "created_at": 1756252800,
                                            "updated_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/entity-types/4c2b9f10-5e37-4a6d-8b91-0f7c3d2a8e64"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/entity-types/{entityType}": {
            "get": {
                "operationId": "entity-types-show",
                "tags": [
                    "Kinds of record"
                ],
                "summary": "Get an entity type",
                "description": "Retrieve one kind of object: what it is called, how it is drawn, and how many records exist of it.\n\nThe type is only the noun. What one of its records holds is described separately, by a template, and the same type may have several of them: the family vault and a professional breeding vault can both handle Animals at completely different levels of detail. Nothing about that structure is in here.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "entityType",
                        "in": "path",
                        "required": true,
                        "description": "The id of the type. A path that is not a uuid answers 404 without a query being run, so neither a sequential number nor the slug reaches anything here.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "An entity type object. A type belonging to somebody else answers 404, which is also what a type that never existed answers, and what a deleted one answers.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The type.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always entity_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "slug": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How the type is addressed in the application itself, in lower case letters, numbers and dashes. It is settled when the type is declared and never rebuilt, so a link that already went out keeps working through any rename. Use it to build a browser link; use the id for every call here."
                                                        },
                                                        "name_singular": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What one of these is called: Animal, Company, Recipe. Up to 255 characters. Reduced to plain text when it was written down, so no markup survives here."
                                                        },
                                                        "name_plural": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What several of them are called. Stored rather than derived from the singular, because a plural derived in English is wrong in most other languages."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the type is for, up to 65535 characters, or null when nobody said."
                                                        },
                                                        "icon": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of profile, logs, security, preferences, key, device, info, life event, mail, sun, moon or check. It is a name rather than a drawing, so the picture lives in the application and the type stores a word."
                                                        },
                                                        "colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Exactly one of #3f5fd0, #4f8a49, #9a6a24, #9a3f2b, #5d5f96 or #1d1d20, written in lower case. It is how types are told apart at a glance in the navigation, and it is decoration: nothing depends on it."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the type sits in the vault navigation, counting from 1. It is the order you arranged, and it is the order the list endpoint answers in. Types that may no longer be filed under are numbered along with the rest, so one switched back on finds the place it had."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether new records may still be filed under the type. False stops the button that adds another and touches nothing already filed: every record stays readable and stays editable."
                                                        },
                                                        "entity_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many records of this kind exist, across every vault of your account. It is a running count kept as records are written down and deleted, rather than something counted when you ask, and it is what decides whether the type may be deleted."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the type was declared, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "entity_type",
                                        "id": "4c2b9f10-5e37-4a6d-8b91-0f7c3d2a8e64",
                                        "attributes": {
                                            "slug": "animal",
                                            "name_singular": "Animal",
                                            "name_plural": "Animals",
                                            "description": "Every creature the family keeps.",
                                            "icon": "profile",
                                            "colour": "#4f8a49",
                                            "position": 1,
                                            "is_active": true,
                                            "entity_count": 12,
                                            "created_at": 1756252800,
                                            "updated_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/entity-types/4c2b9f10-5e37-4a6d-8b91-0f7c3d2a8e64"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "entity-types-show-query",
                "tags": [
                    "Kinds of record"
                ],
                "summary": "Get an entity type",
                "description": "Retrieve one kind of object: what it is called, how it is drawn, and how many records exist of it.\n\nThe type is only the noun. What one of its records holds is described separately, by a template, and the same type may have several of them: the family vault and a professional breeding vault can both handle Animals at completely different levels of detail. Nothing about that structure is in here.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "entityType",
                        "in": "path",
                        "required": true,
                        "description": "The id of the type. A path that is not a uuid answers 404 without a query being run, so neither a sequential number nor the slug reaches anything here.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "An entity type object. A type belonging to somebody else answers 404, which is also what a type that never existed answers, and what a deleted one answers.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The type.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always entity_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "slug": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How the type is addressed in the application itself, in lower case letters, numbers and dashes. It is settled when the type is declared and never rebuilt, so a link that already went out keeps working through any rename. Use it to build a browser link; use the id for every call here."
                                                        },
                                                        "name_singular": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What one of these is called: Animal, Company, Recipe. Up to 255 characters. Reduced to plain text when it was written down, so no markup survives here."
                                                        },
                                                        "name_plural": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What several of them are called. Stored rather than derived from the singular, because a plural derived in English is wrong in most other languages."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the type is for, up to 65535 characters, or null when nobody said."
                                                        },
                                                        "icon": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of profile, logs, security, preferences, key, device, info, life event, mail, sun, moon or check. It is a name rather than a drawing, so the picture lives in the application and the type stores a word."
                                                        },
                                                        "colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Exactly one of #3f5fd0, #4f8a49, #9a6a24, #9a3f2b, #5d5f96 or #1d1d20, written in lower case. It is how types are told apart at a glance in the navigation, and it is decoration: nothing depends on it."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the type sits in the vault navigation, counting from 1. It is the order you arranged, and it is the order the list endpoint answers in. Types that may no longer be filed under are numbered along with the rest, so one switched back on finds the place it had."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether new records may still be filed under the type. False stops the button that adds another and touches nothing already filed: every record stays readable and stays editable."
                                                        },
                                                        "entity_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many records of this kind exist, across every vault of your account. It is a running count kept as records are written down and deleted, rather than something counted when you ask, and it is what decides whether the type may be deleted."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the type was declared, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "entity_type",
                                        "id": "4c2b9f10-5e37-4a6d-8b91-0f7c3d2a8e64",
                                        "attributes": {
                                            "slug": "animal",
                                            "name_singular": "Animal",
                                            "name_plural": "Animals",
                                            "description": "Every creature the family keeps.",
                                            "icon": "profile",
                                            "colour": "#4f8a49",
                                            "position": 1,
                                            "is_active": true,
                                            "entity_count": 12,
                                            "created_at": 1756252800,
                                            "updated_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/entity-types/4c2b9f10-5e37-4a6d-8b91-0f7c3d2a8e64"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "put": {
                "operationId": "entity-types-update",
                "tags": [
                    "Kinds of record"
                ],
                "summary": "Update an entity type",
                "description": "Change what a kind of object is called, what it is for, and how it is drawn.\n\nSend only what changes. The names, the icon and the colour cannot be null and are refused with 422 when sent as null. A description sent as null is cleared.\n\nThe slug is left alone. A rename is a change of wording rather than a change of thing: Animal becoming Pet is the same type, and every link that already went out keeps working. Where the type sits in your navigation, whether records may still be filed under it, and everything already filed under it are each untouched here.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "entityType",
                        "in": "path",
                        "required": true,
                        "description": "The id of the type. A path that is not a uuid answers 404 without a query being run, so neither a sequential number nor the slug reaches anything here.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name_singular": {
                                        "type": "string",
                                        "description": "What one of these is called. Up to 255 characters."
                                    },
                                    "name_plural": {
                                        "type": "string",
                                        "description": "What several of them are called. Up to 255 characters."
                                    },
                                    "description": {
                                        "type": "string",
                                        "description": "What the type is for, up to 65535 characters. Null says it has none."
                                    },
                                    "icon": {
                                        "type": "string",
                                        "description": "One of profile, logs, security, preferences, key, device, info, life event, mail, sun, moon or check."
                                    },
                                    "colour": {
                                        "type": "string",
                                        "description": "Exactly one of #3f5fd0, #4f8a49, #9a6a24, #9a3f2b, #5d5f96 or #1d1d20, written in lower case."
                                    }
                                }
                            },
                            "example": {
                                "name_singular": "Pet",
                                "name_plural": "Pets",
                                "description": "Every creature the family keeps.",
                                "icon": "profile",
                                "colour": "#4f8a49"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The entity type object as it now reads. A type belonging to somebody else answers 404 and is left as it was.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The type.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always entity_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "slug": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How the type is addressed in the application itself, in lower case letters, numbers and dashes. It is settled when the type is declared and never rebuilt, so a link that already went out keeps working through any rename. Use it to build a browser link; use the id for every call here."
                                                        },
                                                        "name_singular": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What one of these is called: Animal, Company, Recipe. Up to 255 characters. Reduced to plain text when it was written down, so no markup survives here."
                                                        },
                                                        "name_plural": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What several of them are called. Stored rather than derived from the singular, because a plural derived in English is wrong in most other languages."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the type is for, up to 65535 characters, or null when nobody said."
                                                        },
                                                        "icon": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of profile, logs, security, preferences, key, device, info, life event, mail, sun, moon or check. It is a name rather than a drawing, so the picture lives in the application and the type stores a word."
                                                        },
                                                        "colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Exactly one of #3f5fd0, #4f8a49, #9a6a24, #9a3f2b, #5d5f96 or #1d1d20, written in lower case. It is how types are told apart at a glance in the navigation, and it is decoration: nothing depends on it."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the type sits in the vault navigation, counting from 1. It is the order you arranged, and it is the order the list endpoint answers in. Types that may no longer be filed under are numbered along with the rest, so one switched back on finds the place it had."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether new records may still be filed under the type. False stops the button that adds another and touches nothing already filed: every record stays readable and stays editable."
                                                        },
                                                        "entity_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many records of this kind exist, across every vault of your account. It is a running count kept as records are written down and deleted, rather than something counted when you ask, and it is what decides whether the type may be deleted."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the type was declared, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "entity_type",
                                        "id": "4c2b9f10-5e37-4a6d-8b91-0f7c3d2a8e64",
                                        "attributes": {
                                            "slug": "animal",
                                            "name_singular": "Animal",
                                            "name_plural": "Animals",
                                            "description": "Every creature the family keeps.",
                                            "icon": "profile",
                                            "colour": "#4f8a49",
                                            "position": 1,
                                            "is_active": true,
                                            "entity_count": 12,
                                            "created_at": 1756252800,
                                            "updated_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/entity-types/4c2b9f10-5e37-4a6d-8b91-0f7c3d2a8e64"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "delete": {
                "operationId": "entity-types-destroy",
                "tags": [
                    "Kinds of record"
                ],
                "summary": "Delete an entity type",
                "description": "Delete a kind of object, which is only allowed while no record of it exists.\n\nA type that still holds records refuses to go, and answers 422 saying how many it holds. Taking a hundred animals down with the word \"Animal\" is not something one call should be able to do. The two ways forward are to delete those records first, deliberately, or to stop the type being offered and keep everything filed under it.\n\nThe deletion is soft, so nothing is destroyed, but no endpoint here brings a type back today. The slug is not released with it either: a link that went out pointing at this type must not later land on a different one, so declaring a new type with the same slug is refused.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "entityType",
                        "in": "path",
                        "required": true,
                        "description": "The id of the type. A path that is not a uuid answers 404 without a query being run, so neither a sequential number nor the slug reaches anything here.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Nothing at all. A type that still holds records answers 422 and stays. A type belonging to somebody else answers 404, and so does one you have already deleted, so calling this twice does not report a second deletion."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/entity-types/{entityType}/activation": {
            "put": {
                "operationId": "entity-types-activation",
                "tags": [
                    "Kinds of record"
                ],
                "summary": "Offer or stop offering an entity type",
                "description": "Say whether records may still be filed under a kind of object.\n\nThis is what a type in use gets instead of a deletion. Stopping one touches nothing already filed under it: every record stays readable and stays editable, and only the button that adds another goes. An account that has finished cataloguing its wine bottles wants the bottles, not the button.\n\nThe place the type has in your navigation is kept, so offering it again puts it back where it was rather than at the end.\n\nIt has its own endpoint because it is a decision about your account rather than a correction to the wording of the type, and it cannot therefore be made by accident while renaming one. Send the state you want rather than asking for a toggle: sending the same state twice confirms it instead of inverting it.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "entityType",
                        "in": "path",
                        "required": true,
                        "description": "The id of the type. A path that is not a uuid answers 404 without a query being run, so neither a sequential number nor the slug reaches anything here.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "is_active": {
                                        "type": "boolean",
                                        "description": "True to let records be filed under the type again, false to stop new ones being filed. The state you want, not a change: sending the state the type is already in changes nothing and answers with the type."
                                    }
                                },
                                "required": [
                                    "is_active"
                                ]
                            },
                            "example": {
                                "is_active": false
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The entity type object as it now reads. A type belonging to somebody else answers 404 and is left as it was.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The type.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always entity_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "slug": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How the type is addressed in the application itself, in lower case letters, numbers and dashes. It is settled when the type is declared and never rebuilt, so a link that already went out keeps working through any rename. Use it to build a browser link; use the id for every call here."
                                                        },
                                                        "name_singular": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What one of these is called: Animal, Company, Recipe. Up to 255 characters. Reduced to plain text when it was written down, so no markup survives here."
                                                        },
                                                        "name_plural": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What several of them are called. Stored rather than derived from the singular, because a plural derived in English is wrong in most other languages."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the type is for, up to 65535 characters, or null when nobody said."
                                                        },
                                                        "icon": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of profile, logs, security, preferences, key, device, info, life event, mail, sun, moon or check. It is a name rather than a drawing, so the picture lives in the application and the type stores a word."
                                                        },
                                                        "colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Exactly one of #3f5fd0, #4f8a49, #9a6a24, #9a3f2b, #5d5f96 or #1d1d20, written in lower case. It is how types are told apart at a glance in the navigation, and it is decoration: nothing depends on it."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the type sits in the vault navigation, counting from 1. It is the order you arranged, and it is the order the list endpoint answers in. Types that may no longer be filed under are numbered along with the rest, so one switched back on finds the place it had."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether new records may still be filed under the type. False stops the button that adds another and touches nothing already filed: every record stays readable and stays editable."
                                                        },
                                                        "entity_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many records of this kind exist, across every vault of your account. It is a running count kept as records are written down and deleted, rather than something counted when you ask, and it is what decides whether the type may be deleted."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the type was declared, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "entity_type",
                                        "id": "4c2b9f10-5e37-4a6d-8b91-0f7c3d2a8e64",
                                        "attributes": {
                                            "slug": "animal",
                                            "name_singular": "Animal",
                                            "name_plural": "Animals",
                                            "description": "Every creature the family keeps.",
                                            "icon": "profile",
                                            "colour": "#4f8a49",
                                            "position": 1,
                                            "is_active": true,
                                            "entity_count": 12,
                                            "created_at": 1756252800,
                                            "updated_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/entity-types/4c2b9f10-5e37-4a6d-8b91-0f7c3d2a8e64"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/entity-types/{entityType}/position": {
            "put": {
                "operationId": "entity-types-position",
                "tags": [
                    "Kinds of record"
                ],
                "summary": "Move an entity type",
                "description": "Move a kind of object in your navigation, so the ones you open daily are the ones you reach first.\n\nThe type is taken out and put back at the position you asked for, and every type of your account is then numbered from one again. Ask for a position past the end and it goes last. Ask for the position it already holds and nothing moves.\n\nTypes nobody may file records under are numbered along with the rest, since one you offer again has to find the place it had.\n\nThe list endpoint answers in this order, so moving a type changes what every caller reads next.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "entityType",
                        "in": "path",
                        "required": true,
                        "description": "The id of the type. A path that is not a uuid answers 404 without a query being run, so neither a sequential number nor the slug reaches anything here.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "position": {
                                        "type": "integer",
                                        "description": "Where the type should sit, counting from 1. A number past the end puts it last. Below 1 is refused, because there is no place before the first."
                                    }
                                },
                                "required": [
                                    "position"
                                ]
                            },
                            "example": {
                                "position": 1
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The entity type object as it now reads, carrying its new position. A type belonging to somebody else answers 404 and nothing is renumbered.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The type.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always entity_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "slug": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How the type is addressed in the application itself, in lower case letters, numbers and dashes. It is settled when the type is declared and never rebuilt, so a link that already went out keeps working through any rename. Use it to build a browser link; use the id for every call here."
                                                        },
                                                        "name_singular": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What one of these is called: Animal, Company, Recipe. Up to 255 characters. Reduced to plain text when it was written down, so no markup survives here."
                                                        },
                                                        "name_plural": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What several of them are called. Stored rather than derived from the singular, because a plural derived in English is wrong in most other languages."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the type is for, up to 65535 characters, or null when nobody said."
                                                        },
                                                        "icon": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of profile, logs, security, preferences, key, device, info, life event, mail, sun, moon or check. It is a name rather than a drawing, so the picture lives in the application and the type stores a word."
                                                        },
                                                        "colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Exactly one of #3f5fd0, #4f8a49, #9a6a24, #9a3f2b, #5d5f96 or #1d1d20, written in lower case. It is how types are told apart at a glance in the navigation, and it is decoration: nothing depends on it."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the type sits in the vault navigation, counting from 1. It is the order you arranged, and it is the order the list endpoint answers in. Types that may no longer be filed under are numbered along with the rest, so one switched back on finds the place it had."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether new records may still be filed under the type. False stops the button that adds another and touches nothing already filed: every record stays readable and stays editable."
                                                        },
                                                        "entity_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many records of this kind exist, across every vault of your account. It is a running count kept as records are written down and deleted, rather than something counted when you ask, and it is what decides whether the type may be deleted."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the type was declared, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "entity_type",
                                        "id": "4c2b9f10-5e37-4a6d-8b91-0f7c3d2a8e64",
                                        "attributes": {
                                            "slug": "animal",
                                            "name_singular": "Animal",
                                            "name_plural": "Animals",
                                            "description": "Every creature the family keeps.",
                                            "icon": "profile",
                                            "colour": "#4f8a49",
                                            "position": 1,
                                            "is_active": true,
                                            "entity_count": 12,
                                            "created_at": 1756252800,
                                            "updated_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/entity-types/4c2b9f10-5e37-4a6d-8b91-0f7c3d2a8e64"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/entity-types/{entityType}/entities": {
            "get": {
                "operationId": "entities-index",
                "tags": [
                    "Kinds of record"
                ],
                "summary": "List the records of a kind",
                "description": "List the records of one kind kept in one vault, by name.\n\nArchived records are listed with the others and marked. A record of the same kind in another vault is never listed here.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the records live in, named either by the readable name it reports as slug or by its id. Both answer.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "entityType",
                        "in": "path",
                        "required": true,
                        "description": "The kind of record. A type the vault does not use, which is one with no published template set for it there and no record in it, answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to answer with.",
                        "schema": {
                            "type": "integer",
                            "default": 1
                        }
                    },
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "How many types one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused.",
                        "schema": {
                            "type": "integer",
                            "default": 25
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of entity objects, and how many there are in all. A vault or a type belonging to somebody else answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The records on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One record.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always entity. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the record is called, up to 255 characters. It is how the record is listed and sorted, and it is reduced to plain text when it is written down."
                                                            },
                                                            "entity_type_id": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "format": "uuid",
                                                                "description": "The kind of record it is. It never changes."
                                                            },
                                                            "initials": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The first letter of the first two words of the name, drawn on the generated avatar."
                                                            },
                                                            "avatar_colour": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The background the generated avatar is drawn on. It is picked when the record is written down and kept afterwards."
                                                            },
                                                            "avatar": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The picture standing in for the record, with its id and url, or null when it is drawn as its initials."
                                                            },
                                                            "is_archived": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the record was put away. An archived record is still listed."
                                                            },
                                                            "structure_version_id": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "The exact version of the template the record was written on. A record stays on that version until somebody moves it."
                                                            },
                                                            "template_name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The name of the template that version belongs to."
                                                            },
                                                            "fields": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "The values the record holds, in no particular order. A field left empty is not listed.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One value.",
                                                                    "properties": {
                                                                        "field_id": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The id of the field, which is the key a value is written under when the record is updated."
                                                                        },
                                                                        "key": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "How the field is named in an import or an export. It is unique inside its section only."
                                                                        },
                                                                        "label": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "What the field is called on the record."
                                                                        },
                                                                        "type": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The kind of field: text, date, select, address and so on."
                                                                        },
                                                                        "row": {
                                                                            "type": [
                                                                                "integer",
                                                                                "null"
                                                                            ],
                                                                            "description": "For a field inside a repeating group, the id of the repetition it belongs to, which is the id an update keeps that repetition by. Null otherwise."
                                                                        },
                                                                        "value": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The value, written as the page of the record shows it. A file field gives the name of the file. Null when hidden."
                                                                        },
                                                                        "is_hidden": {
                                                                            "type": [
                                                                                "boolean",
                                                                                "null"
                                                                            ],
                                                                            "description": "Whether the value was held back because the field is sensitive and the key does not hold the sensitive-fields scope."
                                                                        }
                                                                    }
                                                                }
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the record was written down, as a count of seconds since 1970."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds, or null."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The page of the record in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "entity",
                                            "id": "9b1e6c42-7a35-4f08-b2d9-5c8e41a7f031",
                                            "attributes": {
                                                "name": "Mose’s goat",
                                                "entity_type_id": "4c2b9f10-5e37-4a6d-8b91-0f7c3d2a8e64",
                                                "initials": "MG",
                                                "avatar_colour": "#22c55e",
                                                "avatar": null,
                                                "is_archived": false,
                                                "structure_version_id": 12,
                                                "template_name": "Basic animal",
                                                "fields": [
                                                    {
                                                        "field_id": "381",
                                                        "key": "species",
                                                        "label": "Species",
                                                        "type": "text",
                                                        "row": null,
                                                        "value": "Goat",
                                                        "is_hidden": false
                                                    }
                                                ],
                                                "created_at": 1758844800,
                                                "updated_at": 1758844800
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/schrute-farms/entities/9b1e6c42-7a35-4f08-b2d9-5c8e41a7f031",
                                                "web": "https://my.monicahq.com/vaults/schrute-farms/entities/animals/9b1e6c42-7a35-4f08-b2d9-5c8e41a7f031"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "entities-index-query",
                "tags": [
                    "Kinds of record"
                ],
                "summary": "List the records of a kind",
                "description": "List the records of one kind kept in one vault, by name.\n\nArchived records are listed with the others and marked. A record of the same kind in another vault is never listed here.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the records live in, named either by the readable name it reports as slug or by its id. Both answer.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "entityType",
                        "in": "path",
                        "required": true,
                        "description": "The kind of record. A type the vault does not use, which is one with no published template set for it there and no record in it, answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "page": {
                                        "type": "integer",
                                        "default": 1,
                                        "description": "Which page to answer with."
                                    },
                                    "per_page": {
                                        "type": "integer",
                                        "default": 25,
                                        "description": "How many types one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "A page of entity objects, and how many there are in all. A vault or a type belonging to somebody else answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The records on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One record.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always entity. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the record is called, up to 255 characters. It is how the record is listed and sorted, and it is reduced to plain text when it is written down."
                                                            },
                                                            "entity_type_id": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "format": "uuid",
                                                                "description": "The kind of record it is. It never changes."
                                                            },
                                                            "initials": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The first letter of the first two words of the name, drawn on the generated avatar."
                                                            },
                                                            "avatar_colour": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The background the generated avatar is drawn on. It is picked when the record is written down and kept afterwards."
                                                            },
                                                            "avatar": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The picture standing in for the record, with its id and url, or null when it is drawn as its initials."
                                                            },
                                                            "is_archived": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the record was put away. An archived record is still listed."
                                                            },
                                                            "structure_version_id": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "The exact version of the template the record was written on. A record stays on that version until somebody moves it."
                                                            },
                                                            "template_name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The name of the template that version belongs to."
                                                            },
                                                            "fields": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "The values the record holds, in no particular order. A field left empty is not listed.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One value.",
                                                                    "properties": {
                                                                        "field_id": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The id of the field, which is the key a value is written under when the record is updated."
                                                                        },
                                                                        "key": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "How the field is named in an import or an export. It is unique inside its section only."
                                                                        },
                                                                        "label": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "What the field is called on the record."
                                                                        },
                                                                        "type": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The kind of field: text, date, select, address and so on."
                                                                        },
                                                                        "row": {
                                                                            "type": [
                                                                                "integer",
                                                                                "null"
                                                                            ],
                                                                            "description": "For a field inside a repeating group, the id of the repetition it belongs to, which is the id an update keeps that repetition by. Null otherwise."
                                                                        },
                                                                        "value": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The value, written as the page of the record shows it. A file field gives the name of the file. Null when hidden."
                                                                        },
                                                                        "is_hidden": {
                                                                            "type": [
                                                                                "boolean",
                                                                                "null"
                                                                            ],
                                                                            "description": "Whether the value was held back because the field is sensitive and the key does not hold the sensitive-fields scope."
                                                                        }
                                                                    }
                                                                }
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the record was written down, as a count of seconds since 1970."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds, or null."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The page of the record in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "entity",
                                            "id": "9b1e6c42-7a35-4f08-b2d9-5c8e41a7f031",
                                            "attributes": {
                                                "name": "Mose’s goat",
                                                "entity_type_id": "4c2b9f10-5e37-4a6d-8b91-0f7c3d2a8e64",
                                                "initials": "MG",
                                                "avatar_colour": "#22c55e",
                                                "avatar": null,
                                                "is_archived": false,
                                                "structure_version_id": 12,
                                                "template_name": "Basic animal",
                                                "fields": [
                                                    {
                                                        "field_id": "381",
                                                        "key": "species",
                                                        "label": "Species",
                                                        "type": "text",
                                                        "row": null,
                                                        "value": "Goat",
                                                        "is_hidden": false
                                                    }
                                                ],
                                                "created_at": 1758844800,
                                                "updated_at": 1758844800
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/schrute-farms/entities/9b1e6c42-7a35-4f08-b2d9-5c8e41a7f031",
                                                "web": "https://my.monicahq.com/vaults/schrute-farms/entities/animals/9b1e6c42-7a35-4f08-b2d9-5c8e41a7f031"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "post": {
                "operationId": "entities-create",
                "tags": [
                    "Kinds of record"
                ],
                "summary": "Create a record",
                "description": "Write down a record of one kind in one vault, with what its template asks.\n\nThe record is written on the published version of the template the vault uses for this kind, or on the one you name in structure_version_id. Everything is written together or nothing is: a value refused in any section leaves no record behind.\n\nA field you leave out starts with the default its template gives it, as it would on a new contact. Send it empty to leave it empty.\n\nA type the vault does not show answers 404. A type the vault still shows because it holds records of it answers 422 with the reason on name when the type was turned off, when the vault has no published template for it and you name none, or when that template requires something that cannot be filled in here.\n\nA relation field takes the id of the record it names: a contact, or a record of the kind the field points at. It has to be in the same vault, and anything else answers 422 on that field.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the records live in, named either by the readable name it reports as slug or by its id. Both answer.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "entityType",
                        "in": "path",
                        "required": true,
                        "description": "The kind of record. A type the vault does not use, which is one with no published template set for it there and no record in it, answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "description": "What the record is called, up to 255 characters."
                                    },
                                    "structure_version_id": {
                                        "type": "integer",
                                        "description": "The published version of one of your active templates for this kind, which says what the record holds. Left out, the record starts from the template the vault uses for this kind. A version of another kind, of a template turned off or belonging to somebody else answers 422 on this field, and so does a version that is no longer the one its template publishes."
                                    },
                                    "fields": {
                                        "type": "object",
                                        "description": "The values, keyed by the id of the field they fill in, each checked against what its field accepts. A field left out writes nothing. Files are sent as multipart under fields[id]."
                                    },
                                    "labels": {
                                        "type": "object",
                                        "description": "The label picked beside a value, keyed by field id, for a field that carries one."
                                    },
                                    "label_wordings": {
                                        "type": "object",
                                        "description": "The wording typed when the picked label is the open one, keyed by field id."
                                    },
                                    "year_is_unknown": {
                                        "type": "object",
                                        "description": "True for a recurring date whose year nobody knows, keyed by field id."
                                    },
                                    "month_is_unknown": {
                                        "type": "object",
                                        "description": "True for a recurring date whose month nobody knows, keyed by field id."
                                    }
                                },
                                "required": [
                                    "name"
                                ]
                            },
                            "example": {
                                "name": "Mose’s goat",
                                "structure_version_id": 12,
                                "fields": {
                                    "381": "Goat"
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The entity object that was written down. A vault or a type belonging to somebody else answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The record.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always entity. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the record is called, up to 255 characters. It is how the record is listed and sorted, and it is reduced to plain text when it is written down."
                                                        },
                                                        "entity_type_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The kind of record it is. It never changes."
                                                        },
                                                        "initials": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The first letter of the first two words of the name, drawn on the generated avatar."
                                                        },
                                                        "avatar_colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The background the generated avatar is drawn on. It is picked when the record is written down and kept afterwards."
                                                        },
                                                        "avatar": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The picture standing in for the record, with its id and url, or null when it is drawn as its initials."
                                                        },
                                                        "is_archived": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the record was put away. An archived record is still listed."
                                                        },
                                                        "structure_version_id": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The exact version of the template the record was written on. A record stays on that version until somebody moves it."
                                                        },
                                                        "template_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The name of the template that version belongs to."
                                                        },
                                                        "fields": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The values the record holds, in no particular order. A field left empty is not listed.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One value.",
                                                                "properties": {
                                                                    "field_id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The id of the field, which is the key a value is written under when the record is updated."
                                                                    },
                                                                    "key": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "How the field is named in an import or an export. It is unique inside its section only."
                                                                    },
                                                                    "label": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field is called on the record."
                                                                    },
                                                                    "type": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The kind of field: text, date, select, address and so on."
                                                                    },
                                                                    "row": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "For a field inside a repeating group, the id of the repetition it belongs to, which is the id an update keeps that repetition by. Null otherwise."
                                                                    },
                                                                    "value": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The value, written as the page of the record shows it. A file field gives the name of the file. Null when hidden."
                                                                    },
                                                                    "is_hidden": {
                                                                        "type": [
                                                                            "boolean",
                                                                            "null"
                                                                        ],
                                                                        "description": "Whether the value was held back because the field is sensitive and the key does not hold the sensitive-fields scope."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the record was written down, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The page of the record in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "entity",
                                        "id": "9b1e6c42-7a35-4f08-b2d9-5c8e41a7f031",
                                        "attributes": {
                                            "name": "Mose’s goat",
                                            "entity_type_id": "4c2b9f10-5e37-4a6d-8b91-0f7c3d2a8e64",
                                            "initials": "MG",
                                            "avatar_colour": "#22c55e",
                                            "avatar": null,
                                            "is_archived": false,
                                            "structure_version_id": 12,
                                            "template_name": "Basic animal",
                                            "fields": [
                                                {
                                                    "field_id": "381",
                                                    "key": "species",
                                                    "label": "Species",
                                                    "type": "text",
                                                    "row": null,
                                                    "value": "Goat",
                                                    "is_hidden": false
                                                }
                                            ],
                                            "created_at": 1758844800,
                                            "updated_at": 1758844800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/schrute-farms/entities/9b1e6c42-7a35-4f08-b2d9-5c8e41a7f031",
                                            "web": "https://my.monicahq.com/vaults/schrute-farms/entities/animals/9b1e6c42-7a35-4f08-b2d9-5c8e41a7f031"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/contacts/{contact}/entities": {
            "get": {
                "operationId": "contacts-entities-index",
                "tags": [
                    "Kinds of record"
                ],
                "summary": "List the records naming a contact",
                "description": "List the records of any kind, such as an animal, that name one contact in one of their relation fields, by name.\n\nA record is listed when one of its relation fields names the contact, inside a repeating group or not. A value set aside by a change of template does not count. Only records of the contact’s own vault are listed, since a relation never crosses vaults.\n\nThis is what the contact’s page shows under Profiles.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the contact lives in, named either by the readable name it reports as slug or by its id. Both answer.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "contact",
                        "in": "path",
                        "required": true,
                        "description": "The contact, named either by its slug or by its id.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to answer with.",
                        "schema": {
                            "type": "integer",
                            "default": 1
                        }
                    },
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "How many types one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused.",
                        "schema": {
                            "type": "integer",
                            "default": 25
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of entity objects, and how many there are in all. A vault or a contact belonging to somebody else answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The records on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One record.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always entity. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the record is called, up to 255 characters. It is how the record is listed and sorted, and it is reduced to plain text when it is written down."
                                                            },
                                                            "entity_type_id": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "format": "uuid",
                                                                "description": "The kind of record it is. It never changes."
                                                            },
                                                            "initials": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The first letter of the first two words of the name, drawn on the generated avatar."
                                                            },
                                                            "avatar_colour": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The background the generated avatar is drawn on. It is picked when the record is written down and kept afterwards."
                                                            },
                                                            "avatar": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The picture standing in for the record, with its id and url, or null when it is drawn as its initials."
                                                            },
                                                            "is_archived": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the record was put away. An archived record is still listed."
                                                            },
                                                            "structure_version_id": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "The exact version of the template the record was written on. A record stays on that version until somebody moves it."
                                                            },
                                                            "template_name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The name of the template that version belongs to."
                                                            },
                                                            "fields": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "The values the record holds, in no particular order. A field left empty is not listed.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One value.",
                                                                    "properties": {
                                                                        "field_id": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The id of the field, which is the key a value is written under when the record is updated."
                                                                        },
                                                                        "key": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "How the field is named in an import or an export. It is unique inside its section only."
                                                                        },
                                                                        "label": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "What the field is called on the record."
                                                                        },
                                                                        "type": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The kind of field: text, date, select, address and so on."
                                                                        },
                                                                        "row": {
                                                                            "type": [
                                                                                "integer",
                                                                                "null"
                                                                            ],
                                                                            "description": "For a field inside a repeating group, the id of the repetition it belongs to, which is the id an update keeps that repetition by. Null otherwise."
                                                                        },
                                                                        "value": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The value, written as the page of the record shows it. A file field gives the name of the file. Null when hidden."
                                                                        },
                                                                        "is_hidden": {
                                                                            "type": [
                                                                                "boolean",
                                                                                "null"
                                                                            ],
                                                                            "description": "Whether the value was held back because the field is sensitive and the key does not hold the sensitive-fields scope."
                                                                        }
                                                                    }
                                                                }
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the record was written down, as a count of seconds since 1970."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds, or null."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The page of the record in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "entity",
                                            "id": "9b1e6c42-7a35-4f08-b2d9-5c8e41a7f031",
                                            "attributes": {
                                                "name": "Mose’s goat",
                                                "entity_type_id": "4c2b9f10-5e37-4a6d-8b91-0f7c3d2a8e64",
                                                "initials": "MG",
                                                "avatar_colour": "#22c55e",
                                                "avatar": null,
                                                "is_archived": false,
                                                "structure_version_id": 12,
                                                "template_name": "Basic animal",
                                                "fields": [
                                                    {
                                                        "field_id": "381",
                                                        "key": "species",
                                                        "label": "Species",
                                                        "type": "text",
                                                        "row": null,
                                                        "value": "Goat",
                                                        "is_hidden": false
                                                    }
                                                ],
                                                "created_at": 1758844800,
                                                "updated_at": 1758844800
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/schrute-farms/entities/9b1e6c42-7a35-4f08-b2d9-5c8e41a7f031",
                                                "web": "https://my.monicahq.com/vaults/schrute-farms/entities/animals/9b1e6c42-7a35-4f08-b2d9-5c8e41a7f031"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "contacts-entities-index-query",
                "tags": [
                    "Kinds of record"
                ],
                "summary": "List the records naming a contact",
                "description": "List the records of any kind, such as an animal, that name one contact in one of their relation fields, by name.\n\nA record is listed when one of its relation fields names the contact, inside a repeating group or not. A value set aside by a change of template does not count. Only records of the contact’s own vault are listed, since a relation never crosses vaults.\n\nThis is what the contact’s page shows under Profiles.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the contact lives in, named either by the readable name it reports as slug or by its id. Both answer.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "contact",
                        "in": "path",
                        "required": true,
                        "description": "The contact, named either by its slug or by its id.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "page": {
                                        "type": "integer",
                                        "default": 1,
                                        "description": "Which page to answer with."
                                    },
                                    "per_page": {
                                        "type": "integer",
                                        "default": 25,
                                        "description": "How many types one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "A page of entity objects, and how many there are in all. A vault or a contact belonging to somebody else answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The records on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One record.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always entity. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the record is called, up to 255 characters. It is how the record is listed and sorted, and it is reduced to plain text when it is written down."
                                                            },
                                                            "entity_type_id": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "format": "uuid",
                                                                "description": "The kind of record it is. It never changes."
                                                            },
                                                            "initials": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The first letter of the first two words of the name, drawn on the generated avatar."
                                                            },
                                                            "avatar_colour": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The background the generated avatar is drawn on. It is picked when the record is written down and kept afterwards."
                                                            },
                                                            "avatar": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The picture standing in for the record, with its id and url, or null when it is drawn as its initials."
                                                            },
                                                            "is_archived": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the record was put away. An archived record is still listed."
                                                            },
                                                            "structure_version_id": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "The exact version of the template the record was written on. A record stays on that version until somebody moves it."
                                                            },
                                                            "template_name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The name of the template that version belongs to."
                                                            },
                                                            "fields": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "The values the record holds, in no particular order. A field left empty is not listed.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One value.",
                                                                    "properties": {
                                                                        "field_id": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The id of the field, which is the key a value is written under when the record is updated."
                                                                        },
                                                                        "key": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "How the field is named in an import or an export. It is unique inside its section only."
                                                                        },
                                                                        "label": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "What the field is called on the record."
                                                                        },
                                                                        "type": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The kind of field: text, date, select, address and so on."
                                                                        },
                                                                        "row": {
                                                                            "type": [
                                                                                "integer",
                                                                                "null"
                                                                            ],
                                                                            "description": "For a field inside a repeating group, the id of the repetition it belongs to, which is the id an update keeps that repetition by. Null otherwise."
                                                                        },
                                                                        "value": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The value, written as the page of the record shows it. A file field gives the name of the file. Null when hidden."
                                                                        },
                                                                        "is_hidden": {
                                                                            "type": [
                                                                                "boolean",
                                                                                "null"
                                                                            ],
                                                                            "description": "Whether the value was held back because the field is sensitive and the key does not hold the sensitive-fields scope."
                                                                        }
                                                                    }
                                                                }
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the record was written down, as a count of seconds since 1970."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds, or null."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The page of the record in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "entity",
                                            "id": "9b1e6c42-7a35-4f08-b2d9-5c8e41a7f031",
                                            "attributes": {
                                                "name": "Mose’s goat",
                                                "entity_type_id": "4c2b9f10-5e37-4a6d-8b91-0f7c3d2a8e64",
                                                "initials": "MG",
                                                "avatar_colour": "#22c55e",
                                                "avatar": null,
                                                "is_archived": false,
                                                "structure_version_id": 12,
                                                "template_name": "Basic animal",
                                                "fields": [
                                                    {
                                                        "field_id": "381",
                                                        "key": "species",
                                                        "label": "Species",
                                                        "type": "text",
                                                        "row": null,
                                                        "value": "Goat",
                                                        "is_hidden": false
                                                    }
                                                ],
                                                "created_at": 1758844800,
                                                "updated_at": 1758844800
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/schrute-farms/entities/9b1e6c42-7a35-4f08-b2d9-5c8e41a7f031",
                                                "web": "https://my.monicahq.com/vaults/schrute-farms/entities/animals/9b1e6c42-7a35-4f08-b2d9-5c8e41a7f031"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/entities/{entity}": {
            "get": {
                "operationId": "entities-show",
                "tags": [
                    "Kinds of record"
                ],
                "summary": "Get a record",
                "description": "Read one record with every value it holds.\n\nThe values are those of the template version the record was written on, even when the template has moved on since.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the record lives in, named either by the readable name it reports as slug or by its id. Both answer.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "entity",
                        "in": "path",
                        "required": true,
                        "description": "The id of the record, as the list of records gives it.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The entity object. A record in another vault, or belonging to somebody else, answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The record.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always entity. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the record is called, up to 255 characters. It is how the record is listed and sorted, and it is reduced to plain text when it is written down."
                                                        },
                                                        "entity_type_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The kind of record it is. It never changes."
                                                        },
                                                        "initials": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The first letter of the first two words of the name, drawn on the generated avatar."
                                                        },
                                                        "avatar_colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The background the generated avatar is drawn on. It is picked when the record is written down and kept afterwards."
                                                        },
                                                        "avatar": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The picture standing in for the record, with its id and url, or null when it is drawn as its initials."
                                                        },
                                                        "is_archived": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the record was put away. An archived record is still listed."
                                                        },
                                                        "structure_version_id": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The exact version of the template the record was written on. A record stays on that version until somebody moves it."
                                                        },
                                                        "template_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The name of the template that version belongs to."
                                                        },
                                                        "fields": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The values the record holds, in no particular order. A field left empty is not listed.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One value.",
                                                                "properties": {
                                                                    "field_id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The id of the field, which is the key a value is written under when the record is updated."
                                                                    },
                                                                    "key": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "How the field is named in an import or an export. It is unique inside its section only."
                                                                    },
                                                                    "label": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field is called on the record."
                                                                    },
                                                                    "type": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The kind of field: text, date, select, address and so on."
                                                                    },
                                                                    "row": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "For a field inside a repeating group, the id of the repetition it belongs to, which is the id an update keeps that repetition by. Null otherwise."
                                                                    },
                                                                    "value": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The value, written as the page of the record shows it. A file field gives the name of the file. Null when hidden."
                                                                    },
                                                                    "is_hidden": {
                                                                        "type": [
                                                                            "boolean",
                                                                            "null"
                                                                        ],
                                                                        "description": "Whether the value was held back because the field is sensitive and the key does not hold the sensitive-fields scope."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the record was written down, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The page of the record in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "entity",
                                        "id": "9b1e6c42-7a35-4f08-b2d9-5c8e41a7f031",
                                        "attributes": {
                                            "name": "Mose’s goat",
                                            "entity_type_id": "4c2b9f10-5e37-4a6d-8b91-0f7c3d2a8e64",
                                            "initials": "MG",
                                            "avatar_colour": "#22c55e",
                                            "avatar": null,
                                            "is_archived": false,
                                            "structure_version_id": 12,
                                            "template_name": "Basic animal",
                                            "fields": [
                                                {
                                                    "field_id": "381",
                                                    "key": "species",
                                                    "label": "Species",
                                                    "type": "text",
                                                    "row": null,
                                                    "value": "Goat",
                                                    "is_hidden": false
                                                }
                                            ],
                                            "created_at": 1758844800,
                                            "updated_at": 1758844800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/schrute-farms/entities/9b1e6c42-7a35-4f08-b2d9-5c8e41a7f031",
                                            "web": "https://my.monicahq.com/vaults/schrute-farms/entities/animals/9b1e6c42-7a35-4f08-b2d9-5c8e41a7f031"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "entities-show-query",
                "tags": [
                    "Kinds of record"
                ],
                "summary": "Get a record",
                "description": "Read one record with every value it holds.\n\nThe values are those of the template version the record was written on, even when the template has moved on since.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the record lives in, named either by the readable name it reports as slug or by its id. Both answer.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "entity",
                        "in": "path",
                        "required": true,
                        "description": "The id of the record, as the list of records gives it.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The entity object. A record in another vault, or belonging to somebody else, answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The record.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always entity. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the record is called, up to 255 characters. It is how the record is listed and sorted, and it is reduced to plain text when it is written down."
                                                        },
                                                        "entity_type_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The kind of record it is. It never changes."
                                                        },
                                                        "initials": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The first letter of the first two words of the name, drawn on the generated avatar."
                                                        },
                                                        "avatar_colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The background the generated avatar is drawn on. It is picked when the record is written down and kept afterwards."
                                                        },
                                                        "avatar": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The picture standing in for the record, with its id and url, or null when it is drawn as its initials."
                                                        },
                                                        "is_archived": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the record was put away. An archived record is still listed."
                                                        },
                                                        "structure_version_id": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The exact version of the template the record was written on. A record stays on that version until somebody moves it."
                                                        },
                                                        "template_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The name of the template that version belongs to."
                                                        },
                                                        "fields": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The values the record holds, in no particular order. A field left empty is not listed.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One value.",
                                                                "properties": {
                                                                    "field_id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The id of the field, which is the key a value is written under when the record is updated."
                                                                    },
                                                                    "key": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "How the field is named in an import or an export. It is unique inside its section only."
                                                                    },
                                                                    "label": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field is called on the record."
                                                                    },
                                                                    "type": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The kind of field: text, date, select, address and so on."
                                                                    },
                                                                    "row": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "For a field inside a repeating group, the id of the repetition it belongs to, which is the id an update keeps that repetition by. Null otherwise."
                                                                    },
                                                                    "value": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The value, written as the page of the record shows it. A file field gives the name of the file. Null when hidden."
                                                                    },
                                                                    "is_hidden": {
                                                                        "type": [
                                                                            "boolean",
                                                                            "null"
                                                                        ],
                                                                        "description": "Whether the value was held back because the field is sensitive and the key does not hold the sensitive-fields scope."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the record was written down, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The page of the record in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "entity",
                                        "id": "9b1e6c42-7a35-4f08-b2d9-5c8e41a7f031",
                                        "attributes": {
                                            "name": "Mose’s goat",
                                            "entity_type_id": "4c2b9f10-5e37-4a6d-8b91-0f7c3d2a8e64",
                                            "initials": "MG",
                                            "avatar_colour": "#22c55e",
                                            "avatar": null,
                                            "is_archived": false,
                                            "structure_version_id": 12,
                                            "template_name": "Basic animal",
                                            "fields": [
                                                {
                                                    "field_id": "381",
                                                    "key": "species",
                                                    "label": "Species",
                                                    "type": "text",
                                                    "row": null,
                                                    "value": "Goat",
                                                    "is_hidden": false
                                                }
                                            ],
                                            "created_at": 1758844800,
                                            "updated_at": 1758844800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/schrute-farms/entities/9b1e6c42-7a35-4f08-b2d9-5c8e41a7f031",
                                            "web": "https://my.monicahq.com/vaults/schrute-farms/entities/animals/9b1e6c42-7a35-4f08-b2d9-5c8e41a7f031"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "put": {
                "operationId": "entities-update",
                "tags": [
                    "Kinds of record"
                ],
                "summary": "Update a record",
                "description": "Correct the name of a record and the values its template holds.\n\nWhat you leave out is kept: a name not sent stays as it is, and so does every field not named in fields. A field sent as null is emptied.\n\nThe record stays on the template version it was written on. Only the fields of that version can be written, and each value is checked against what its field accepts.\n\nA name sent empty answers 422 on name. A value refused by its field answers 422 on that field, and a required field emptied answers 422 on fields.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the record lives in, named either by the readable name it reports as slug or by its id. Both answer.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "entity",
                        "in": "path",
                        "required": true,
                        "description": "The id of the record, as the list of records gives it.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "description": "What the record is called, up to 255 characters. It cannot be emptied."
                                    },
                                    "fields": {
                                        "type": "object",
                                        "description": "The values to write, keyed by the id of the field they fill in, as the fields of the record give it. A repeating group takes a list of repetitions, each holding its id when it already exists and its values keyed by the ids of the fields inside the group."
                                    },
                                    "labels": {
                                        "type": "object",
                                        "description": "The label picked beside a value, keyed by field id, for a field that carries one."
                                    },
                                    "label_wordings": {
                                        "type": "object",
                                        "description": "The wording typed when the picked label is the open one, keyed by field id."
                                    },
                                    "year_is_unknown": {
                                        "type": "object",
                                        "description": "True for a recurring date whose year nobody knows, keyed by field id."
                                    },
                                    "month_is_unknown": {
                                        "type": "object",
                                        "description": "True for a recurring date whose month nobody knows, keyed by field id."
                                    }
                                }
                            },
                            "example": {
                                "name": "Mose’s best goat",
                                "fields": {
                                    "381": "Sheep"
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The entity object as it now reads. A record in another vault, or belonging to somebody else, answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The record.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always entity. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the record is called, up to 255 characters. It is how the record is listed and sorted, and it is reduced to plain text when it is written down."
                                                        },
                                                        "entity_type_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The kind of record it is. It never changes."
                                                        },
                                                        "initials": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The first letter of the first two words of the name, drawn on the generated avatar."
                                                        },
                                                        "avatar_colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The background the generated avatar is drawn on. It is picked when the record is written down and kept afterwards."
                                                        },
                                                        "avatar": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The picture standing in for the record, with its id and url, or null when it is drawn as its initials."
                                                        },
                                                        "is_archived": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the record was put away. An archived record is still listed."
                                                        },
                                                        "structure_version_id": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The exact version of the template the record was written on. A record stays on that version until somebody moves it."
                                                        },
                                                        "template_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The name of the template that version belongs to."
                                                        },
                                                        "fields": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The values the record holds, in no particular order. A field left empty is not listed.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One value.",
                                                                "properties": {
                                                                    "field_id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The id of the field, which is the key a value is written under when the record is updated."
                                                                    },
                                                                    "key": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "How the field is named in an import or an export. It is unique inside its section only."
                                                                    },
                                                                    "label": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field is called on the record."
                                                                    },
                                                                    "type": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The kind of field: text, date, select, address and so on."
                                                                    },
                                                                    "row": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "For a field inside a repeating group, the id of the repetition it belongs to, which is the id an update keeps that repetition by. Null otherwise."
                                                                    },
                                                                    "value": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The value, written as the page of the record shows it. A file field gives the name of the file. Null when hidden."
                                                                    },
                                                                    "is_hidden": {
                                                                        "type": [
                                                                            "boolean",
                                                                            "null"
                                                                        ],
                                                                        "description": "Whether the value was held back because the field is sensitive and the key does not hold the sensitive-fields scope."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the record was written down, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The page of the record in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "entity",
                                        "id": "9b1e6c42-7a35-4f08-b2d9-5c8e41a7f031",
                                        "attributes": {
                                            "name": "Mose’s goat",
                                            "entity_type_id": "4c2b9f10-5e37-4a6d-8b91-0f7c3d2a8e64",
                                            "initials": "MG",
                                            "avatar_colour": "#22c55e",
                                            "avatar": null,
                                            "is_archived": false,
                                            "structure_version_id": 12,
                                            "template_name": "Basic animal",
                                            "fields": [
                                                {
                                                    "field_id": "381",
                                                    "key": "species",
                                                    "label": "Species",
                                                    "type": "text",
                                                    "row": null,
                                                    "value": "Goat",
                                                    "is_hidden": false
                                                }
                                            ],
                                            "created_at": 1758844800,
                                            "updated_at": 1758844800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/schrute-farms/entities/9b1e6c42-7a35-4f08-b2d9-5c8e41a7f031",
                                            "web": "https://my.monicahq.com/vaults/schrute-farms/entities/animals/9b1e6c42-7a35-4f08-b2d9-5c8e41a7f031"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/logs": {
            "get": {
                "operationId": "logs-index",
                "tags": [
                    "Logs"
                ],
                "summary": "List logs",
                "description": "List what has been done in your account, newest first.\n\nThe account log belongs to the account rather than to you, which matters in one case: an entry the application wrote on its own has nobody behind it, and those are exactly the entries nobody watched happen. Its author reads as the system and it carries no address.\n\nEach entry carries both the raw name of the action, which is what a program matches on, and a sentence in the language on your account, which is what a person reads.\n\nNothing here can be written, changed or removed. A log that can be rewritten is worth nothing, so there is no endpoint for it.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to answer with.",
                        "schema": {
                            "type": "integer",
                            "default": 1
                        }
                    },
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "How many entries one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused.",
                        "schema": {
                            "type": "integer",
                            "default": 25
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of account log entries, and how many there are in all.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The entries on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One entry.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always log. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "author": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Who did it: their name while they are still on the account, the address they had once they are not, and a translated phrase reading The system for anything the product did on its own. Worked out when you ask rather than stored, so a deleted person still reads as somebody."
                                                            },
                                                            "action": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What was done, as a key such as vault_created or contact_deleted, up to 255 characters. The keys come from a set the product keeps and adds to as it gains capabilities, and the column is a plain string rather than a fixed set, so match the ones you care about and let an unfamiliar one through rather than treating it as an error."
                                                            },
                                                            "parameters": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "additionalProperties": true,
                                                                "description": "What the action was about, as whatever that kind of action recorded. The keys depend entirely on the action, so nothing here promises a shape: a vault creation carries the name of the vault, another action carries something else."
                                                            },
                                                            "description": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The entry as a sentence a person can read, with the parameters already put into it. Worked out when you ask, and in the language of whoever is asking."
                                                            },
                                                            "source": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Where it came from: one of web, api, mcp, import, automation, module or system. It is how a change made by a script is told from one made by hand."
                                                            },
                                                            "ip_address": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The address the request came from, up to 45 characters so that a version six address fits, or null when nothing was recorded, which is the case for anything the system did on its own."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it happened, as a count of seconds since 1970. The account log is append only, so this never moves."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "log",
                                            "id": "12",
                                            "attributes": {
                                                "author": "Michael Scott",
                                                "action": "api_key_created",
                                                "parameters": {
                                                    "name": "Dundie awards bot"
                                                },
                                                "description": "Created the API key called Dundie awards bot",
                                                "source": "web",
                                                "ip_address": "192.168.1.24",
                                                "created_at": 1756339200
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/logs/12"
                                            }
                                        },
                                        {
                                            "type": "log",
                                            "id": "11",
                                            "attributes": {
                                                "author": "The system",
                                                "action": "account_created",
                                                "parameters": null,
                                                "description": "Created the account",
                                                "source": "system",
                                                "ip_address": null,
                                                "created_at": 1756252800
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/logs/11"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 2
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "logs-index-query",
                "tags": [
                    "Logs"
                ],
                "summary": "List logs",
                "description": "List what has been done in your account, newest first.\n\nThe account log belongs to the account rather than to you, which matters in one case: an entry the application wrote on its own has nobody behind it, and those are exactly the entries nobody watched happen. Its author reads as the system and it carries no address.\n\nEach entry carries both the raw name of the action, which is what a program matches on, and a sentence in the language on your account, which is what a person reads.\n\nNothing here can be written, changed or removed. A log that can be rewritten is worth nothing, so there is no endpoint for it.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "page": {
                                        "type": "integer",
                                        "default": 1,
                                        "description": "Which page to answer with."
                                    },
                                    "per_page": {
                                        "type": "integer",
                                        "default": 25,
                                        "description": "How many entries one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "A page of account log entries, and how many there are in all.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The entries on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One entry.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always log. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "author": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Who did it: their name while they are still on the account, the address they had once they are not, and a translated phrase reading The system for anything the product did on its own. Worked out when you ask rather than stored, so a deleted person still reads as somebody."
                                                            },
                                                            "action": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What was done, as a key such as vault_created or contact_deleted, up to 255 characters. The keys come from a set the product keeps and adds to as it gains capabilities, and the column is a plain string rather than a fixed set, so match the ones you care about and let an unfamiliar one through rather than treating it as an error."
                                                            },
                                                            "parameters": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "additionalProperties": true,
                                                                "description": "What the action was about, as whatever that kind of action recorded. The keys depend entirely on the action, so nothing here promises a shape: a vault creation carries the name of the vault, another action carries something else."
                                                            },
                                                            "description": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The entry as a sentence a person can read, with the parameters already put into it. Worked out when you ask, and in the language of whoever is asking."
                                                            },
                                                            "source": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Where it came from: one of web, api, mcp, import, automation, module or system. It is how a change made by a script is told from one made by hand."
                                                            },
                                                            "ip_address": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The address the request came from, up to 45 characters so that a version six address fits, or null when nothing was recorded, which is the case for anything the system did on its own."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it happened, as a count of seconds since 1970. The account log is append only, so this never moves."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "log",
                                            "id": "12",
                                            "attributes": {
                                                "author": "Michael Scott",
                                                "action": "api_key_created",
                                                "parameters": {
                                                    "name": "Dundie awards bot"
                                                },
                                                "description": "Created the API key called Dundie awards bot",
                                                "source": "web",
                                                "ip_address": "192.168.1.24",
                                                "created_at": 1756339200
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/logs/12"
                                            }
                                        },
                                        {
                                            "type": "log",
                                            "id": "11",
                                            "attributes": {
                                                "author": "The system",
                                                "action": "account_created",
                                                "parameters": null,
                                                "description": "Created the account",
                                                "source": "system",
                                                "ip_address": null,
                                                "created_at": 1756252800
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/logs/11"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 2
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/logs/{log}": {
            "get": {
                "operationId": "logs-show",
                "tags": [
                    "Logs"
                ],
                "summary": "Get a log",
                "description": "Retrieve one entry of your account log.\n\nWhat changed is not in here. A field somebody marked sensitive records that it changed and not what to, and until the product settles how those values may be kept, the whole column stays out of the API rather than half of it coming through.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "log",
                        "in": "path",
                        "required": true,
                        "description": "The id of the entry.",
                        "schema": {
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "An account log entry. An entry from another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The entry.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always log. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "author": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Who did it: their name while they are still on the account, the address they had once they are not, and a translated phrase reading The system for anything the product did on its own. Worked out when you ask rather than stored, so a deleted person still reads as somebody."
                                                        },
                                                        "action": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What was done, as a key such as vault_created or contact_deleted, up to 255 characters. The keys come from a set the product keeps and adds to as it gains capabilities, and the column is a plain string rather than a fixed set, so match the ones you care about and let an unfamiliar one through rather than treating it as an error."
                                                        },
                                                        "parameters": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "additionalProperties": true,
                                                            "description": "What the action was about, as whatever that kind of action recorded. The keys depend entirely on the action, so nothing here promises a shape: a vault creation carries the name of the vault, another action carries something else."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The entry as a sentence a person can read, with the parameters already put into it. Worked out when you ask, and in the language of whoever is asking."
                                                        },
                                                        "source": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where it came from: one of web, api, mcp, import, automation, module or system. It is how a change made by a script is told from one made by hand."
                                                        },
                                                        "ip_address": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The address the request came from, up to 45 characters so that a version six address fits, or null when nothing was recorded, which is the case for anything the system did on its own."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it happened, as a count of seconds since 1970. The account log is append only, so this never moves."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "log",
                                        "id": "12",
                                        "attributes": {
                                            "author": "Michael Scott",
                                            "action": "api_key_created",
                                            "parameters": {
                                                "name": "Dundie awards bot"
                                            },
                                            "description": "Created the API key called Dundie awards bot",
                                            "source": "web",
                                            "ip_address": "192.168.1.24",
                                            "created_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/logs/12"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "logs-show-query",
                "tags": [
                    "Logs"
                ],
                "summary": "Get a log",
                "description": "Retrieve one entry of your account log.\n\nWhat changed is not in here. A field somebody marked sensitive records that it changed and not what to, and until the product settles how those values may be kept, the whole column stays out of the API rather than half of it coming through.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "log",
                        "in": "path",
                        "required": true,
                        "description": "The id of the entry.",
                        "schema": {
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "An account log entry. An entry from another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The entry.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always log. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "author": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Who did it: their name while they are still on the account, the address they had once they are not, and a translated phrase reading The system for anything the product did on its own. Worked out when you ask rather than stored, so a deleted person still reads as somebody."
                                                        },
                                                        "action": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What was done, as a key such as vault_created or contact_deleted, up to 255 characters. The keys come from a set the product keeps and adds to as it gains capabilities, and the column is a plain string rather than a fixed set, so match the ones you care about and let an unfamiliar one through rather than treating it as an error."
                                                        },
                                                        "parameters": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "additionalProperties": true,
                                                            "description": "What the action was about, as whatever that kind of action recorded. The keys depend entirely on the action, so nothing here promises a shape: a vault creation carries the name of the vault, another action carries something else."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The entry as a sentence a person can read, with the parameters already put into it. Worked out when you ask, and in the language of whoever is asking."
                                                        },
                                                        "source": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where it came from: one of web, api, mcp, import, automation, module or system. It is how a change made by a script is told from one made by hand."
                                                        },
                                                        "ip_address": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The address the request came from, up to 45 characters so that a version six address fits, or null when nothing was recorded, which is the case for anything the system did on its own."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it happened, as a count of seconds since 1970. The account log is append only, so this never moves."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "log",
                                        "id": "12",
                                        "attributes": {
                                            "author": "Michael Scott",
                                            "action": "api_key_created",
                                            "parameters": {
                                                "name": "Dundie awards bot"
                                            },
                                            "description": "Created the API key called Dundie awards bot",
                                            "source": "web",
                                            "ip_address": "192.168.1.24",
                                            "created_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/logs/12"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/emails-sent": {
            "get": {
                "operationId": "emails-sent-index",
                "tags": [
                    "Emails sent"
                ],
                "summary": "List emails sent",
                "description": "List the emails we sent on behalf of your account, most recently sent first.\n\nThis is the same record the emails screen in your settings shows, which is where to look when somebody says a sign-in link never arrived. Each email carries the three moments that can happen to it, when it left, when it arrived and when it came back, and one word that reads them for you.\n\nThe copy of each email is deliberately left out of this list. A page holds twenty five emails by default, and carrying the full text of each would turn a list somebody is scanning into a download. Ask for one email to read what it said.\n\nThe record belongs to the account rather than to you personally, so an email we sent to an address that has no account of its own is still listed here.\n\nNothing here can be written, changed or removed. The record is written as the mail leaves and updated only when the provider tells us what became of it.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to answer with.",
                        "schema": {
                            "type": "integer",
                            "default": 1
                        }
                    },
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "How many emails one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused.",
                        "schema": {
                            "type": "integer",
                            "default": 25
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of emails we sent, and how many there are in all. An account that has never had an email leave gets an empty list rather than an error.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The emails on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One email.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always email_sent. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "email_type": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Which of our emails this was, as a key such as new_login or magic_link_created, up to 255 characters. The keys come from a set the product keeps and adds to as it sends new kinds of mail, so match the ones you care about and let an unfamiliar one through rather than treating it as an error."
                                                            },
                                                            "subject": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The subject line as it was sent, of no fixed length, or null for a record written before we kept them."
                                                            },
                                                            "email_address": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The address it went to, up to 255 characters. It need not belong to anybody with an account: what matters is that it left on behalf of yours."
                                                            },
                                                            "delivery_status": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Where the email got to: one of complained, bounced, delivered or sent. It is the one word you want out of the four moments below, worked out the same way the account screen works it out, and read in that order, so a complaint outranks a bounce and either outranks a delivery when a provider reports them out of order."
                                                            },
                                                            "sent_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it left us, as a count of seconds since 1970, or null for a record written before we kept it. This is the moment the list is ordered by."
                                                            },
                                                            "delivered_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the provider told us it arrived, as a count of seconds, or null when nobody has told us. Null means we have not heard, not that it failed."
                                                            },
                                                            "bounced_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it came back, as a count of seconds, or null when it has not. An email with a moment here reached nobody, whether the receiving server refused it or our provider never managed to send it at all."
                                                            },
                                                            "complained_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the recipient marked it as spam, as a count of seconds, or null when they have not. It is a separate fact from a bounce: the address works, the person did not want the email."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the record was written, as a count of seconds. Usually the same second it was sent, and not the same field."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "email_sent",
                                            "id": "42",
                                            "attributes": {
                                                "email_type": "new_login",
                                                "subject": "A sign-in from a new place",
                                                "email_address": "michael.scott@dundermifflin.com",
                                                "delivery_status": "delivered",
                                                "sent_at": 1756339200,
                                                "delivered_at": 1756339260,
                                                "bounced_at": null,
                                                "complained_at": null,
                                                "created_at": 1756339200
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/emails-sent/42"
                                            }
                                        },
                                        {
                                            "type": "email_sent",
                                            "id": "41",
                                            "attributes": {
                                                "email_type": "magic_link_created",
                                                "subject": "Your sign-in link",
                                                "email_address": "dwight.schrute@dundermifflin.com",
                                                "delivery_status": "bounced",
                                                "sent_at": 1756252800,
                                                "delivered_at": null,
                                                "bounced_at": 1756252860,
                                                "complained_at": null,
                                                "created_at": 1756252800
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/emails-sent/41"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 2
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "emails-sent-index-query",
                "tags": [
                    "Emails sent"
                ],
                "summary": "List emails sent",
                "description": "List the emails we sent on behalf of your account, most recently sent first.\n\nThis is the same record the emails screen in your settings shows, which is where to look when somebody says a sign-in link never arrived. Each email carries the three moments that can happen to it, when it left, when it arrived and when it came back, and one word that reads them for you.\n\nThe copy of each email is deliberately left out of this list. A page holds twenty five emails by default, and carrying the full text of each would turn a list somebody is scanning into a download. Ask for one email to read what it said.\n\nThe record belongs to the account rather than to you personally, so an email we sent to an address that has no account of its own is still listed here.\n\nNothing here can be written, changed or removed. The record is written as the mail leaves and updated only when the provider tells us what became of it.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "page": {
                                        "type": "integer",
                                        "default": 1,
                                        "description": "Which page to answer with."
                                    },
                                    "per_page": {
                                        "type": "integer",
                                        "default": 25,
                                        "description": "How many emails one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "A page of emails we sent, and how many there are in all. An account that has never had an email leave gets an empty list rather than an error.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The emails on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One email.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always email_sent. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "email_type": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Which of our emails this was, as a key such as new_login or magic_link_created, up to 255 characters. The keys come from a set the product keeps and adds to as it sends new kinds of mail, so match the ones you care about and let an unfamiliar one through rather than treating it as an error."
                                                            },
                                                            "subject": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The subject line as it was sent, of no fixed length, or null for a record written before we kept them."
                                                            },
                                                            "email_address": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The address it went to, up to 255 characters. It need not belong to anybody with an account: what matters is that it left on behalf of yours."
                                                            },
                                                            "delivery_status": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Where the email got to: one of complained, bounced, delivered or sent. It is the one word you want out of the four moments below, worked out the same way the account screen works it out, and read in that order, so a complaint outranks a bounce and either outranks a delivery when a provider reports them out of order."
                                                            },
                                                            "sent_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it left us, as a count of seconds since 1970, or null for a record written before we kept it. This is the moment the list is ordered by."
                                                            },
                                                            "delivered_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the provider told us it arrived, as a count of seconds, or null when nobody has told us. Null means we have not heard, not that it failed."
                                                            },
                                                            "bounced_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it came back, as a count of seconds, or null when it has not. An email with a moment here reached nobody, whether the receiving server refused it or our provider never managed to send it at all."
                                                            },
                                                            "complained_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the recipient marked it as spam, as a count of seconds, or null when they have not. It is a separate fact from a bounce: the address works, the person did not want the email."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the record was written, as a count of seconds. Usually the same second it was sent, and not the same field."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "email_sent",
                                            "id": "42",
                                            "attributes": {
                                                "email_type": "new_login",
                                                "subject": "A sign-in from a new place",
                                                "email_address": "michael.scott@dundermifflin.com",
                                                "delivery_status": "delivered",
                                                "sent_at": 1756339200,
                                                "delivered_at": 1756339260,
                                                "bounced_at": null,
                                                "complained_at": null,
                                                "created_at": 1756339200
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/emails-sent/42"
                                            }
                                        },
                                        {
                                            "type": "email_sent",
                                            "id": "41",
                                            "attributes": {
                                                "email_type": "magic_link_created",
                                                "subject": "Your sign-in link",
                                                "email_address": "dwight.schrute@dundermifflin.com",
                                                "delivery_status": "bounced",
                                                "sent_at": 1756252800,
                                                "delivered_at": null,
                                                "bounced_at": 1756252860,
                                                "complained_at": null,
                                                "created_at": 1756252800
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/emails-sent/41"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 2
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/emails-sent/{emailSent}": {
            "get": {
                "operationId": "emails-sent-show",
                "tags": [
                    "Emails sent"
                ],
                "summary": "Get an email sent",
                "description": "Retrieve one email we sent, including the copy that left.\n\nEverything a row in the list carries, and one field more: `body`, the text of the email as it was sent. That is what tells you what we actually said, rather than only that we said something.\n\nThe `delivery_status` is one of three words. `delivered` means it arrived, `bounced` means it came back, and `sent` means it left and nothing has come back yet. When a provider reports a delivery and a bounce for the same email, which it can do out of order, the email reads as `bounced`.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "emailSent",
                        "in": "path",
                        "required": true,
                        "description": "The id of the email.",
                        "schema": {
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "One email we sent. An email belonging to another account answers 404, and so does an id that matches nothing, deliberately: the two cannot be told apart.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The email.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always email_sent. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "email_type": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Which of our emails this was, as a key such as new_login or magic_link_created, up to 255 characters. The keys come from a set the product keeps and adds to as it sends new kinds of mail, so match the ones you care about and let an unfamiliar one through rather than treating it as an error."
                                                        },
                                                        "subject": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The subject line as it was sent, of no fixed length, or null for a record written before we kept them."
                                                        },
                                                        "email_address": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The address it went to, up to 255 characters. It need not belong to anybody with an account: what matters is that it left on behalf of yours."
                                                        },
                                                        "body": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The copy that was sent, or null for a record written before we kept it. It is carried only when one email is read, never on a list row, so that asking for a page never turns into a download. Links and web addresses are removed from the copy before it is kept, so a sign-in link can never be read back."
                                                        },
                                                        "delivery_status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the email got to: one of complained, bounced, delivered or sent. It is the one word you want out of the four moments below, worked out the same way the account screen works it out, and read in that order, so a complaint outranks a bounce and either outranks a delivery when a provider reports them out of order."
                                                        },
                                                        "sent_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it left us, as a count of seconds since 1970, or null for a record written before we kept it. This is the moment the list is ordered by."
                                                        },
                                                        "delivered_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the provider told us it arrived, as a count of seconds, or null when nobody has told us. Null means we have not heard, not that it failed."
                                                        },
                                                        "bounced_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it came back, as a count of seconds, or null when it has not. An email with a moment here reached nobody, whether the receiving server refused it or our provider never managed to send it at all."
                                                        },
                                                        "complained_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the recipient marked it as spam, as a count of seconds, or null when they have not. It is a separate fact from a bounce: the address works, the person did not want the email."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the record was written, as a count of seconds. Usually the same second it was sent, and not the same field."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "email_sent",
                                        "id": "42",
                                        "attributes": {
                                            "email_type": "new_login",
                                            "subject": "A sign-in from a new place",
                                            "email_address": "michael.scott@dundermifflin.com",
                                            "body": "Somebody just signed in to your account from a device we have not seen before.",
                                            "delivery_status": "delivered",
                                            "sent_at": 1756339200,
                                            "delivered_at": 1756339260,
                                            "bounced_at": null,
                                            "complained_at": null,
                                            "created_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/emails-sent/42"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "emails-sent-show-query",
                "tags": [
                    "Emails sent"
                ],
                "summary": "Get an email sent",
                "description": "Retrieve one email we sent, including the copy that left.\n\nEverything a row in the list carries, and one field more: `body`, the text of the email as it was sent. That is what tells you what we actually said, rather than only that we said something.\n\nThe `delivery_status` is one of three words. `delivered` means it arrived, `bounced` means it came back, and `sent` means it left and nothing has come back yet. When a provider reports a delivery and a bounce for the same email, which it can do out of order, the email reads as `bounced`.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "emailSent",
                        "in": "path",
                        "required": true,
                        "description": "The id of the email.",
                        "schema": {
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "One email we sent. An email belonging to another account answers 404, and so does an id that matches nothing, deliberately: the two cannot be told apart.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The email.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always email_sent. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "email_type": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Which of our emails this was, as a key such as new_login or magic_link_created, up to 255 characters. The keys come from a set the product keeps and adds to as it sends new kinds of mail, so match the ones you care about and let an unfamiliar one through rather than treating it as an error."
                                                        },
                                                        "subject": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The subject line as it was sent, of no fixed length, or null for a record written before we kept them."
                                                        },
                                                        "email_address": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The address it went to, up to 255 characters. It need not belong to anybody with an account: what matters is that it left on behalf of yours."
                                                        },
                                                        "body": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The copy that was sent, or null for a record written before we kept it. It is carried only when one email is read, never on a list row, so that asking for a page never turns into a download. Links and web addresses are removed from the copy before it is kept, so a sign-in link can never be read back."
                                                        },
                                                        "delivery_status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the email got to: one of complained, bounced, delivered or sent. It is the one word you want out of the four moments below, worked out the same way the account screen works it out, and read in that order, so a complaint outranks a bounce and either outranks a delivery when a provider reports them out of order."
                                                        },
                                                        "sent_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it left us, as a count of seconds since 1970, or null for a record written before we kept it. This is the moment the list is ordered by."
                                                        },
                                                        "delivered_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the provider told us it arrived, as a count of seconds, or null when nobody has told us. Null means we have not heard, not that it failed."
                                                        },
                                                        "bounced_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it came back, as a count of seconds, or null when it has not. An email with a moment here reached nobody, whether the receiving server refused it or our provider never managed to send it at all."
                                                        },
                                                        "complained_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the recipient marked it as spam, as a count of seconds, or null when they have not. It is a separate fact from a bounce: the address works, the person did not want the email."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the record was written, as a count of seconds. Usually the same second it was sent, and not the same field."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "email_sent",
                                        "id": "42",
                                        "attributes": {
                                            "email_type": "new_login",
                                            "subject": "A sign-in from a new place",
                                            "email_address": "michael.scott@dundermifflin.com",
                                            "body": "Somebody just signed in to your account from a device we have not seen before.",
                                            "delivery_status": "delivered",
                                            "sent_at": 1756339200,
                                            "delivered_at": 1756339260,
                                            "bounced_at": null,
                                            "complained_at": null,
                                            "created_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/emails-sent/42"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/status": {
            "get": {
                "operationId": "status-show",
                "tags": [
                    "Health"
                ],
                "summary": "Check status",
                "description": "Tells you whether the instance is up and which release it runs. No token needed, so you can point a monitor at it.\n\nRate limit: Sixty requests per minute, per address.",
                "responses": {
                    "200": {
                        "description": "The state of the instance, or a 503 status when something it depends on is unreachable.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "status": {
                                            "type": [
                                                "string",
                                                "null"
                                            ],
                                            "description": "Always ok in this answer. An instance that cannot reach its database answers 503 instead, carrying status of error and nothing else, and one that is not running answers nothing at all. Those three are what a monitor watches for."
                                        },
                                        "version": {
                                            "type": [
                                                "string",
                                                "null"
                                            ],
                                            "description": "The release the instance runs, as a semantic version such as 3.0.0. It is how a caller can tell whether a capability it needs has landed here yet."
                                        },
                                        "instance": {
                                            "type": [
                                                "string",
                                                "null"
                                            ],
                                            "description": "The host answering, so a monitor watching several self hosted instances can tell them apart."
                                        }
                                    }
                                },
                                "example": {
                                    "status": "ok",
                                    "version": "3.0.0",
                                    "instance": "app.monicahq.com"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                },
                "security": []
            },
            "query": {
                "operationId": "status-show-query",
                "tags": [
                    "Health"
                ],
                "summary": "Check status",
                "description": "Tells you whether the instance is up and which release it runs. No token needed, so you can point a monitor at it.\n\nRate limit: Sixty requests per minute, per address.",
                "responses": {
                    "200": {
                        "description": "The state of the instance, or a 503 status when something it depends on is unreachable.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "status": {
                                            "type": [
                                                "string",
                                                "null"
                                            ],
                                            "description": "Always ok in this answer. An instance that cannot reach its database answers 503 instead, carrying status of error and nothing else, and one that is not running answers nothing at all. Those three are what a monitor watches for."
                                        },
                                        "version": {
                                            "type": [
                                                "string",
                                                "null"
                                            ],
                                            "description": "The release the instance runs, as a semantic version such as 3.0.0. It is how a caller can tell whether a capability it needs has landed here yet."
                                        },
                                        "instance": {
                                            "type": [
                                                "string",
                                                "null"
                                            ],
                                            "description": "The host answering, so a monitor watching several self hosted instances can tell them apart."
                                        }
                                    }
                                },
                                "example": {
                                    "status": "ok",
                                    "version": "3.0.0",
                                    "instance": "app.monicahq.com"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                },
                "security": []
            }
        },
        "/templates": {
            "get": {
                "operationId": "templates-index",
                "tags": [
                    "Templates"
                ],
                "summary": "List templates",
                "description": "List the templates your account holds, in the order you arranged them.\n\nA template decides what a record shows. It is the definition behind a contact page, or behind everything the account keeps about an Animal. It belongs to your account rather than to one vault, so a template defined once can be used in every vault you hold.\n\nThe template itself holds no fields. What it holds is versions, and what a version holds is pages, sections and fields. That split is what keeps records stable while structures change: a record points at a precise version and follows it until somebody moves it deliberately.\n\nTemplates that may no longer be applied are listed with the rest, because one that is off is meant to be found again and switched back on. Templates the product supplied are listed too, marked with is_system. A deleted template is never listed, and an account answers with an empty list rather than an error when it holds none.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to answer with.",
                        "schema": {
                            "type": "integer",
                            "default": 1
                        }
                    },
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "How many one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused.",
                        "schema": {
                            "type": "integer",
                            "default": 25
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of template objects, and how many there are in all.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The templates on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One template.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always template. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "slug": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "How the template is addressed in the application itself, in lower case letters, numbers and dashes. It is settled when the template is created and never rebuilt, so a link that already went out keeps working through any rename. Use it to build a browser link; use the id for every call here."
                                                            },
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the template is called. A template the product supplied answers with the name translated into your language rather than the one stored, so the same template reads differently to two people."
                                                            },
                                                            "description": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the template is for, or null when nobody said."
                                                            },
                                                            "applies_to": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Either contact or entity. A template describing a contact applies to the people in every vault; one describing an entity applies only to records of the type named in entity_type_id."
                                                            },
                                                            "entity_type_id": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The id of the entity type this template describes, or null when it describes contacts. Read that type through the entity types endpoints."
                                                            },
                                                            "is_system": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the product supplied the template rather than you. It says where the template came from and locks nothing: a supplied template is renamed, moved, stopped and deleted exactly like one you made. Duplicating it first is usually the better move, because a copy leaves the original for anything already using it."
                                                            },
                                                            "is_active": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the template may still be applied to a record. False stops it being offered and touches nothing already using it: every record on it stays readable and stays editable."
                                                            },
                                                            "position": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "Where the template sits in the list on the templates screen, counting from 1. It is the order you arranged, and it is the order the list endpoint answers in."
                                                            },
                                                            "published_version_number": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "The number of the version records are put on when the template is applied today, or null when nothing has been published yet. A template with no published version is one still being designed."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the template was created, as a count of seconds since 1970 rather than a written date."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "template",
                                            "id": "7b1c4e92-3d58-4f07-9a26-8c5b0e14d3af",
                                            "attributes": {
                                                "slug": "contact",
                                                "name": "Contact",
                                                "description": "What every person in a vault shows.",
                                                "applies_to": "contact",
                                                "entity_type_id": null,
                                                "is_system": false,
                                                "is_active": true,
                                                "position": 1,
                                                "published_version_number": 3,
                                                "created_at": 1756252800,
                                                "updated_at": 1756339200
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/templates/7b1c4e92-3d58-4f07-9a26-8c5b0e14d3af"
                                            }
                                        },
                                        {
                                            "type": "template",
                                            "id": "c9d02a67-4b13-4e85-b7f1-2a6d8e903c54",
                                            "attributes": {
                                                "slug": "animal",
                                                "name": "Animal",
                                                "description": null,
                                                "applies_to": "entity",
                                                "entity_type_id": "4c2b9f10-5e37-4a6d-8b91-0f7c3d2a8e64",
                                                "is_system": false,
                                                "is_active": false,
                                                "position": 2,
                                                "published_version_number": null,
                                                "created_at": 1756166400,
                                                "updated_at": 1756166400
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/templates/c9d02a67-4b13-4e85-b7f1-2a6d8e903c54"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 2
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "templates-index-query",
                "tags": [
                    "Templates"
                ],
                "summary": "List templates",
                "description": "List the templates your account holds, in the order you arranged them.\n\nA template decides what a record shows. It is the definition behind a contact page, or behind everything the account keeps about an Animal. It belongs to your account rather than to one vault, so a template defined once can be used in every vault you hold.\n\nThe template itself holds no fields. What it holds is versions, and what a version holds is pages, sections and fields. That split is what keeps records stable while structures change: a record points at a precise version and follows it until somebody moves it deliberately.\n\nTemplates that may no longer be applied are listed with the rest, because one that is off is meant to be found again and switched back on. Templates the product supplied are listed too, marked with is_system. A deleted template is never listed, and an account answers with an empty list rather than an error when it holds none.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "page": {
                                        "type": "integer",
                                        "default": 1,
                                        "description": "Which page to answer with."
                                    },
                                    "per_page": {
                                        "type": "integer",
                                        "default": 25,
                                        "description": "How many one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "A page of template objects, and how many there are in all.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The templates on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One template.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always template. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "slug": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "How the template is addressed in the application itself, in lower case letters, numbers and dashes. It is settled when the template is created and never rebuilt, so a link that already went out keeps working through any rename. Use it to build a browser link; use the id for every call here."
                                                            },
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the template is called. A template the product supplied answers with the name translated into your language rather than the one stored, so the same template reads differently to two people."
                                                            },
                                                            "description": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the template is for, or null when nobody said."
                                                            },
                                                            "applies_to": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Either contact or entity. A template describing a contact applies to the people in every vault; one describing an entity applies only to records of the type named in entity_type_id."
                                                            },
                                                            "entity_type_id": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The id of the entity type this template describes, or null when it describes contacts. Read that type through the entity types endpoints."
                                                            },
                                                            "is_system": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the product supplied the template rather than you. It says where the template came from and locks nothing: a supplied template is renamed, moved, stopped and deleted exactly like one you made. Duplicating it first is usually the better move, because a copy leaves the original for anything already using it."
                                                            },
                                                            "is_active": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the template may still be applied to a record. False stops it being offered and touches nothing already using it: every record on it stays readable and stays editable."
                                                            },
                                                            "position": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "Where the template sits in the list on the templates screen, counting from 1. It is the order you arranged, and it is the order the list endpoint answers in."
                                                            },
                                                            "published_version_number": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "The number of the version records are put on when the template is applied today, or null when nothing has been published yet. A template with no published version is one still being designed."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the template was created, as a count of seconds since 1970 rather than a written date."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "template",
                                            "id": "7b1c4e92-3d58-4f07-9a26-8c5b0e14d3af",
                                            "attributes": {
                                                "slug": "contact",
                                                "name": "Contact",
                                                "description": "What every person in a vault shows.",
                                                "applies_to": "contact",
                                                "entity_type_id": null,
                                                "is_system": false,
                                                "is_active": true,
                                                "position": 1,
                                                "published_version_number": 3,
                                                "created_at": 1756252800,
                                                "updated_at": 1756339200
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/templates/7b1c4e92-3d58-4f07-9a26-8c5b0e14d3af"
                                            }
                                        },
                                        {
                                            "type": "template",
                                            "id": "c9d02a67-4b13-4e85-b7f1-2a6d8e903c54",
                                            "attributes": {
                                                "slug": "animal",
                                                "name": "Animal",
                                                "description": null,
                                                "applies_to": "entity",
                                                "entity_type_id": "4c2b9f10-5e37-4a6d-8b91-0f7c3d2a8e64",
                                                "is_system": false,
                                                "is_active": false,
                                                "position": 2,
                                                "published_version_number": null,
                                                "created_at": 1756166400,
                                                "updated_at": 1756166400
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/templates/c9d02a67-4b13-4e85-b7f1-2a6d8e903c54"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 2
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "post": {
                "operationId": "templates-create",
                "tags": [
                    "Templates"
                ],
                "summary": "Create a template",
                "description": "Define a new kind of record: what a contact page shows, or everything the account keeps about one kind of thing.\n\nThe template starts empty and goes at the end of your list. It is created with a draft version numbered 1 holding a single page and nothing on it, so there is somewhere to build before anything is published. Until you publish, the template has no published version and cannot be applied to a record.\n\nThe slug is settled here and never rebuilt afterwards, so a link that already went out keeps working through any rename. It is made from the name.\n\nA template describing an entity has to name the type it describes, and that type has to be one of yours. A template describing a contact names none.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "description": "What the template is called. Up to 255 characters. Markup and surrounding blank space are stripped."
                                    },
                                    "applies_to": {
                                        "type": "string",
                                        "description": "Either contact or entity."
                                    },
                                    "description": {
                                        "type": "string",
                                        "description": "What the template is for. Up to 65535 characters. Absent, empty or null all mean it has none."
                                    },
                                    "entity_type_id": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "The entity type this template describes. Required when applies_to is entity, refused as invalid when the type belongs to somebody else, and ignored when applies_to is contact."
                                    }
                                },
                                "required": [
                                    "name",
                                    "applies_to"
                                ]
                            },
                            "example": {
                                "name": "Wine bottle",
                                "applies_to": "contact",
                                "description": "Everything the cellar holds."
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The template that was created, with its settled slug and no published version.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The template.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always template. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "slug": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How the template is addressed in the application itself, in lower case letters, numbers and dashes. It is settled when the template is created and never rebuilt, so a link that already went out keeps working through any rename. Use it to build a browser link; use the id for every call here."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the template is called. A template the product supplied answers with the name translated into your language rather than the one stored, so the same template reads differently to two people."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the template is for, or null when nobody said."
                                                        },
                                                        "applies_to": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either contact or entity. A template describing a contact applies to the people in every vault; one describing an entity applies only to records of the type named in entity_type_id."
                                                        },
                                                        "entity_type_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The id of the entity type this template describes, or null when it describes contacts. Read that type through the entity types endpoints."
                                                        },
                                                        "is_system": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the product supplied the template rather than you. It says where the template came from and locks nothing: a supplied template is renamed, moved, stopped and deleted exactly like one you made. Duplicating it first is usually the better move, because a copy leaves the original for anything already using it."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the template may still be applied to a record. False stops it being offered and touches nothing already using it: every record on it stays readable and stays editable."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the template sits in the list on the templates screen, counting from 1. It is the order you arranged, and it is the order the list endpoint answers in."
                                                        },
                                                        "published_version_number": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The number of the version records are put on when the template is applied today, or null when nothing has been published yet. A template with no published version is one still being designed."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the template was created, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "template",
                                        "id": "7b1c4e92-3d58-4f07-9a26-8c5b0e14d3af",
                                        "attributes": {
                                            "slug": "contact",
                                            "name": "Contact",
                                            "description": "What every person in a vault shows.",
                                            "applies_to": "contact",
                                            "entity_type_id": null,
                                            "is_system": false,
                                            "is_active": true,
                                            "position": 1,
                                            "published_version_number": 3,
                                            "created_at": 1756252800,
                                            "updated_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/templates/7b1c4e92-3d58-4f07-9a26-8c5b0e14d3af"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/templates/{template}": {
            "get": {
                "operationId": "templates-show",
                "tags": [
                    "Templates"
                ],
                "summary": "Get a template",
                "description": "Retrieve one template: what it is called, what it applies to, and which of its versions is the published one.\n\nThis answers with the container and not with the structure. To read what a record on this template actually shows, take published_version_number from here and read that version.\n\nA template with no published version is one still being designed. It is a valid state, and it is the state every template starts in.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "template",
                        "in": "path",
                        "required": true,
                        "description": "The id of the template. A path that is not a uuid answers 404 without a query being run, so neither the slug nor a sequential number reaches anything here.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A template object. A template belonging to somebody else answers 404, which is also what a template that never existed answers, and what a deleted one answers.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The template.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always template. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "slug": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How the template is addressed in the application itself, in lower case letters, numbers and dashes. It is settled when the template is created and never rebuilt, so a link that already went out keeps working through any rename. Use it to build a browser link; use the id for every call here."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the template is called. A template the product supplied answers with the name translated into your language rather than the one stored, so the same template reads differently to two people."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the template is for, or null when nobody said."
                                                        },
                                                        "applies_to": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either contact or entity. A template describing a contact applies to the people in every vault; one describing an entity applies only to records of the type named in entity_type_id."
                                                        },
                                                        "entity_type_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The id of the entity type this template describes, or null when it describes contacts. Read that type through the entity types endpoints."
                                                        },
                                                        "is_system": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the product supplied the template rather than you. It says where the template came from and locks nothing: a supplied template is renamed, moved, stopped and deleted exactly like one you made. Duplicating it first is usually the better move, because a copy leaves the original for anything already using it."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the template may still be applied to a record. False stops it being offered and touches nothing already using it: every record on it stays readable and stays editable."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the template sits in the list on the templates screen, counting from 1. It is the order you arranged, and it is the order the list endpoint answers in."
                                                        },
                                                        "published_version_number": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The number of the version records are put on when the template is applied today, or null when nothing has been published yet. A template with no published version is one still being designed."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the template was created, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "template",
                                        "id": "7b1c4e92-3d58-4f07-9a26-8c5b0e14d3af",
                                        "attributes": {
                                            "slug": "contact",
                                            "name": "Contact",
                                            "description": "What every person in a vault shows.",
                                            "applies_to": "contact",
                                            "entity_type_id": null,
                                            "is_system": false,
                                            "is_active": true,
                                            "position": 1,
                                            "published_version_number": 3,
                                            "created_at": 1756252800,
                                            "updated_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/templates/7b1c4e92-3d58-4f07-9a26-8c5b0e14d3af"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "templates-show-query",
                "tags": [
                    "Templates"
                ],
                "summary": "Get a template",
                "description": "Retrieve one template: what it is called, what it applies to, and which of its versions is the published one.\n\nThis answers with the container and not with the structure. To read what a record on this template actually shows, take published_version_number from here and read that version.\n\nA template with no published version is one still being designed. It is a valid state, and it is the state every template starts in.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "template",
                        "in": "path",
                        "required": true,
                        "description": "The id of the template. A path that is not a uuid answers 404 without a query being run, so neither the slug nor a sequential number reaches anything here.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A template object. A template belonging to somebody else answers 404, which is also what a template that never existed answers, and what a deleted one answers.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The template.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always template. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "slug": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How the template is addressed in the application itself, in lower case letters, numbers and dashes. It is settled when the template is created and never rebuilt, so a link that already went out keeps working through any rename. Use it to build a browser link; use the id for every call here."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the template is called. A template the product supplied answers with the name translated into your language rather than the one stored, so the same template reads differently to two people."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the template is for, or null when nobody said."
                                                        },
                                                        "applies_to": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either contact or entity. A template describing a contact applies to the people in every vault; one describing an entity applies only to records of the type named in entity_type_id."
                                                        },
                                                        "entity_type_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The id of the entity type this template describes, or null when it describes contacts. Read that type through the entity types endpoints."
                                                        },
                                                        "is_system": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the product supplied the template rather than you. It says where the template came from and locks nothing: a supplied template is renamed, moved, stopped and deleted exactly like one you made. Duplicating it first is usually the better move, because a copy leaves the original for anything already using it."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the template may still be applied to a record. False stops it being offered and touches nothing already using it: every record on it stays readable and stays editable."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the template sits in the list on the templates screen, counting from 1. It is the order you arranged, and it is the order the list endpoint answers in."
                                                        },
                                                        "published_version_number": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The number of the version records are put on when the template is applied today, or null when nothing has been published yet. A template with no published version is one still being designed."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the template was created, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "template",
                                        "id": "7b1c4e92-3d58-4f07-9a26-8c5b0e14d3af",
                                        "attributes": {
                                            "slug": "contact",
                                            "name": "Contact",
                                            "description": "What every person in a vault shows.",
                                            "applies_to": "contact",
                                            "entity_type_id": null,
                                            "is_system": false,
                                            "is_active": true,
                                            "position": 1,
                                            "published_version_number": 3,
                                            "created_at": 1756252800,
                                            "updated_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/templates/7b1c4e92-3d58-4f07-9a26-8c5b0e14d3af"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "put": {
                "operationId": "templates-update",
                "tags": [
                    "Templates"
                ],
                "summary": "Update a template",
                "description": "Change what a template is called and what it is for.\n\nThis is the wording and nothing else. The slug, the place in the order, every version and every record on them are untouched, so renaming a template is safe at any time and breaks no link that already went out.\n\nWhat the template applies to cannot be changed. A template that describes contacts describes contacts for good, because records already exist on that promise. Build the other one instead.\n\nA name sent as null is refused with 422. A description sent as null is cleared.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "template",
                        "in": "path",
                        "required": true,
                        "description": "The id of the template. A path that is not a uuid answers 404 without a query being run, so neither the slug nor a sequential number reaches anything here.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "description": "What the template is called. Up to 255 characters. It cannot be null."
                                    },
                                    "description": {
                                        "type": "string",
                                        "description": "What the template is for, or null to clear it."
                                    }
                                }
                            },
                            "example": {
                                "name": "Person",
                                "description": "Anybody the family knows."
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The template as it now stands. A template belonging to somebody else answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The template.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always template. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "slug": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How the template is addressed in the application itself, in lower case letters, numbers and dashes. It is settled when the template is created and never rebuilt, so a link that already went out keeps working through any rename. Use it to build a browser link; use the id for every call here."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the template is called. A template the product supplied answers with the name translated into your language rather than the one stored, so the same template reads differently to two people."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the template is for, or null when nobody said."
                                                        },
                                                        "applies_to": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either contact or entity. A template describing a contact applies to the people in every vault; one describing an entity applies only to records of the type named in entity_type_id."
                                                        },
                                                        "entity_type_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The id of the entity type this template describes, or null when it describes contacts. Read that type through the entity types endpoints."
                                                        },
                                                        "is_system": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the product supplied the template rather than you. It says where the template came from and locks nothing: a supplied template is renamed, moved, stopped and deleted exactly like one you made. Duplicating it first is usually the better move, because a copy leaves the original for anything already using it."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the template may still be applied to a record. False stops it being offered and touches nothing already using it: every record on it stays readable and stays editable."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the template sits in the list on the templates screen, counting from 1. It is the order you arranged, and it is the order the list endpoint answers in."
                                                        },
                                                        "published_version_number": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The number of the version records are put on when the template is applied today, or null when nothing has been published yet. A template with no published version is one still being designed."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the template was created, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "template",
                                        "id": "7b1c4e92-3d58-4f07-9a26-8c5b0e14d3af",
                                        "attributes": {
                                            "slug": "contact",
                                            "name": "Contact",
                                            "description": "What every person in a vault shows.",
                                            "applies_to": "contact",
                                            "entity_type_id": null,
                                            "is_system": false,
                                            "is_active": true,
                                            "position": 1,
                                            "published_version_number": 3,
                                            "created_at": 1756252800,
                                            "updated_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/templates/7b1c4e92-3d58-4f07-9a26-8c5b0e14d3af"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "delete": {
                "operationId": "templates-destroy",
                "tags": [
                    "Templates"
                ],
                "summary": "Delete a template",
                "description": "Delete a template that no record is rendered from.\n\nA template still rendering records is refused rather than deleted. Move those records to another template first, or stop offering this one instead, which takes it out of the way without touching anything already using it.\n\nThe last contact template of the account is refused too, because a new vault starts its owner’s contact from one.\n\nA vault starting new records from the deleted template moves to Basic contact or Basic animal, then to the next template the product supplied, then to one of the account’s own. It loses its default only when no template of that kind is left.\n\nThe deletion is recoverable, and the slug stays taken so a link that already went out cannot later land on a different template.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "template",
                        "in": "path",
                        "required": true,
                        "description": "The id of the template. A path that is not a uuid answers 404 without a query being run, so neither the slug nor a sequential number reaches anything here.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Nothing. A template still rendering records, or the last contact template, answers 422, and one belonging to somebody else answers 404."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/templates/{template}/activation": {
            "put": {
                "operationId": "templates-activation-update",
                "tags": [
                    "Templates"
                ],
                "summary": "Offer or stop offering a template",
                "description": "Say whether a template may still be applied to a record.\n\nSend the state you want rather than asking for a toggle, so sending the same state twice confirms it instead of inverting it, and a retried request cannot leave a template in the state you did not ask for.\n\nStopping a template touches nothing already using it. Every record on it stays readable and stays editable, and the template keeps the place it had, so one switched back on returns where it was rather than to the end.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "template",
                        "in": "path",
                        "required": true,
                        "description": "The id of the template. A path that is not a uuid answers 404 without a query being run, so neither the slug nor a sequential number reaches anything here.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "is_active": {
                                        "type": "boolean",
                                        "description": "True to offer the template, false to stop offering it."
                                    }
                                },
                                "required": [
                                    "is_active"
                                ]
                            },
                            "example": {
                                "is_active": false
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The template as it now stands. A template belonging to somebody else answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The template.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always template. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "slug": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How the template is addressed in the application itself, in lower case letters, numbers and dashes. It is settled when the template is created and never rebuilt, so a link that already went out keeps working through any rename. Use it to build a browser link; use the id for every call here."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the template is called. A template the product supplied answers with the name translated into your language rather than the one stored, so the same template reads differently to two people."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the template is for, or null when nobody said."
                                                        },
                                                        "applies_to": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either contact or entity. A template describing a contact applies to the people in every vault; one describing an entity applies only to records of the type named in entity_type_id."
                                                        },
                                                        "entity_type_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The id of the entity type this template describes, or null when it describes contacts. Read that type through the entity types endpoints."
                                                        },
                                                        "is_system": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the product supplied the template rather than you. It says where the template came from and locks nothing: a supplied template is renamed, moved, stopped and deleted exactly like one you made. Duplicating it first is usually the better move, because a copy leaves the original for anything already using it."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the template may still be applied to a record. False stops it being offered and touches nothing already using it: every record on it stays readable and stays editable."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the template sits in the list on the templates screen, counting from 1. It is the order you arranged, and it is the order the list endpoint answers in."
                                                        },
                                                        "published_version_number": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The number of the version records are put on when the template is applied today, or null when nothing has been published yet. A template with no published version is one still being designed."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the template was created, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "template",
                                        "id": "7b1c4e92-3d58-4f07-9a26-8c5b0e14d3af",
                                        "attributes": {
                                            "slug": "contact",
                                            "name": "Contact",
                                            "description": "What every person in a vault shows.",
                                            "applies_to": "contact",
                                            "entity_type_id": null,
                                            "is_system": false,
                                            "is_active": true,
                                            "position": 1,
                                            "published_version_number": 3,
                                            "created_at": 1756252800,
                                            "updated_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/templates/7b1c4e92-3d58-4f07-9a26-8c5b0e14d3af"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/templates/{template}/position": {
            "put": {
                "operationId": "templates-position-update",
                "tags": [
                    "Templates"
                ],
                "summary": "Move a template in the order",
                "description": "Put a template at a given place in the list, counting from 1.\n\nEvery template of the account is numbered from 1 again afterwards, so the positions stay a run of whole numbers with no gaps in it. A place past the end puts the template last rather than being refused.\n\nThe order is what the templates screen shows and what the list endpoint answers in. It has no other meaning: nothing about a record depends on where its template sits.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "template",
                        "in": "path",
                        "required": true,
                        "description": "The id of the template. A path that is not a uuid answers 404 without a query being run, so neither the slug nor a sequential number reaches anything here.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "position": {
                                        "type": "integer",
                                        "description": "Where to put the template, counting from 1."
                                    }
                                },
                                "required": [
                                    "position"
                                ]
                            },
                            "example": {
                                "position": 1
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The template with the place it now holds. A template belonging to somebody else answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The template.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always template. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "slug": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How the template is addressed in the application itself, in lower case letters, numbers and dashes. It is settled when the template is created and never rebuilt, so a link that already went out keeps working through any rename. Use it to build a browser link; use the id for every call here."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the template is called. A template the product supplied answers with the name translated into your language rather than the one stored, so the same template reads differently to two people."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the template is for, or null when nobody said."
                                                        },
                                                        "applies_to": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either contact or entity. A template describing a contact applies to the people in every vault; one describing an entity applies only to records of the type named in entity_type_id."
                                                        },
                                                        "entity_type_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The id of the entity type this template describes, or null when it describes contacts. Read that type through the entity types endpoints."
                                                        },
                                                        "is_system": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the product supplied the template rather than you. It says where the template came from and locks nothing: a supplied template is renamed, moved, stopped and deleted exactly like one you made. Duplicating it first is usually the better move, because a copy leaves the original for anything already using it."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the template may still be applied to a record. False stops it being offered and touches nothing already using it: every record on it stays readable and stays editable."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the template sits in the list on the templates screen, counting from 1. It is the order you arranged, and it is the order the list endpoint answers in."
                                                        },
                                                        "published_version_number": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The number of the version records are put on when the template is applied today, or null when nothing has been published yet. A template with no published version is one still being designed."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the template was created, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "template",
                                        "id": "7b1c4e92-3d58-4f07-9a26-8c5b0e14d3af",
                                        "attributes": {
                                            "slug": "contact",
                                            "name": "Contact",
                                            "description": "What every person in a vault shows.",
                                            "applies_to": "contact",
                                            "entity_type_id": null,
                                            "is_system": false,
                                            "is_active": true,
                                            "position": 1,
                                            "published_version_number": 3,
                                            "created_at": 1756252800,
                                            "updated_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/templates/7b1c4e92-3d58-4f07-9a26-8c5b0e14d3af"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/templates/{template}/duplicate": {
            "post": {
                "operationId": "templates-duplicate-create",
                "tags": [
                    "Templates"
                ],
                "summary": "Duplicate a template",
                "description": "Copy a template and everything it is made of into a separate template of your own.\n\nThis is how you build on a template the product supplied without touching it, and how you try a change out without putting the records of the original at risk. The copy is a separate template with its own id and its own slug, and nothing about the original moves.\n\nWhat is copied is the published version when there is one, and the newest version otherwise. It arrives in the copy as a draft numbered 1, so the copy has nothing published until you publish it. A template with no version at all has nothing to copy and answers 404.\n\nThe copy takes a name and a slug of your choosing, or is given ones derived from the original when you send none.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "template",
                        "in": "path",
                        "required": true,
                        "description": "The id of the template. A path that is not a uuid answers 404 without a query being run, so neither the slug nor a sequential number reaches anything here.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "description": "What to call the copy. Up to 255 characters. Derived from the original when absent."
                                    },
                                    "slug": {
                                        "type": "string",
                                        "description": "The address of the copy. Cleaned the same way a derived one is, and made unique within your account."
                                    }
                                }
                            },
                            "example": {
                                "name": "Contact, expanded",
                                "slug": "contact-expanded"
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The template that was created. A template belonging to somebody else answers 404, and so does one with no version to copy.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The template.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always template. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "slug": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How the template is addressed in the application itself, in lower case letters, numbers and dashes. It is settled when the template is created and never rebuilt, so a link that already went out keeps working through any rename. Use it to build a browser link; use the id for every call here."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the template is called. A template the product supplied answers with the name translated into your language rather than the one stored, so the same template reads differently to two people."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the template is for, or null when nobody said."
                                                        },
                                                        "applies_to": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either contact or entity. A template describing a contact applies to the people in every vault; one describing an entity applies only to records of the type named in entity_type_id."
                                                        },
                                                        "entity_type_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The id of the entity type this template describes, or null when it describes contacts. Read that type through the entity types endpoints."
                                                        },
                                                        "is_system": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the product supplied the template rather than you. It says where the template came from and locks nothing: a supplied template is renamed, moved, stopped and deleted exactly like one you made. Duplicating it first is usually the better move, because a copy leaves the original for anything already using it."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the template may still be applied to a record. False stops it being offered and touches nothing already using it: every record on it stays readable and stays editable."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the template sits in the list on the templates screen, counting from 1. It is the order you arranged, and it is the order the list endpoint answers in."
                                                        },
                                                        "published_version_number": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The number of the version records are put on when the template is applied today, or null when nothing has been published yet. A template with no published version is one still being designed."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the template was created, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "template",
                                        "id": "7b1c4e92-3d58-4f07-9a26-8c5b0e14d3af",
                                        "attributes": {
                                            "slug": "contact",
                                            "name": "Contact",
                                            "description": "What every person in a vault shows.",
                                            "applies_to": "contact",
                                            "entity_type_id": null,
                                            "is_system": false,
                                            "is_active": true,
                                            "position": 1,
                                            "published_version_number": 3,
                                            "created_at": 1756252800,
                                            "updated_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/templates/7b1c4e92-3d58-4f07-9a26-8c5b0e14d3af"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/templates/{template}/versions": {
            "get": {
                "operationId": "template-versions-index",
                "tags": [
                    "Templates"
                ],
                "summary": "List template versions",
                "description": "List the versions of one template, newest first.\n\nEvery change to a structure produces a version rather than editing one, so this is the whole history of the template and the record of what was frozen when. A published version never changes again, which is what lets a record made a year ago go on rendering exactly as it did.\n\nAt most one version is a draft at a time. Publishing a later version does not change an earlier one, so several versions read as published and the template says which one is current. Each keeps its record_count for as long as anything is still on it.\n\nThis answers with the versions and not with what they contain. Read one version to get its pages, its sections and its fields.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "template",
                        "in": "path",
                        "required": true,
                        "description": "The id of the template. A path that is not a uuid answers 404 without a query being run, so neither the slug nor a sequential number reaches anything here.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to answer with.",
                        "schema": {
                            "type": "integer",
                            "default": 1
                        }
                    },
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "How many one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused.",
                        "schema": {
                            "type": "integer",
                            "default": 25
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of version objects, newest first, and how many there are in all. A template belonging to somebody else answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The versions on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One version.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always structure_version. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "version_number": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "Which version this is within its template, counting from 1. It is what the address of this version takes, and what a change note refers to."
                                                            },
                                                            "status": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Either draft or published. A draft is still being designed and may be changed freely. A published version is frozen and never changes again, and stays published after a later version replaces it, so read published_version_number on the template to know which one a new record is put on."
                                                            },
                                                            "change_note": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What changed since the version before, written when this one was published, or null on a draft and on the first version of a template. It is what somebody deciding whether to move their records reads."
                                                            },
                                                            "published_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the version was frozen, as a count of seconds, or null while it is a draft."
                                                            },
                                                            "retired_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "Always null. Publishing a later version does not retire the one it replaces, because the records still on it go on working exactly as they did."
                                                            },
                                                            "record_count": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How many records point at this precise version. A record follows the version it was put on until somebody moves it deliberately, so a retired version keeps a count above zero for as long as anything is still on it."
                                                            },
                                                            "previous_version_number": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "The number of the version this one was started from, or null on the first version of a template."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the version was started, as a count of seconds."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes. A published version never changes, so this stops moving at publication."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "structure_version",
                                            "id": "318",
                                            "attributes": {
                                                "version_number": 4,
                                                "status": "draft",
                                                "change_note": null,
                                                "published_at": null,
                                                "retired_at": null,
                                                "record_count": 0,
                                                "previous_version_number": 3,
                                                "created_at": 1756425600,
                                                "updated_at": 1756425600
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/templates/7b1c4e92-3d58-4f07-9a26-8c5b0e14d3af/versions/4"
                                            }
                                        },
                                        {
                                            "type": "structure_version",
                                            "id": "312",
                                            "attributes": {
                                                "version_number": 3,
                                                "status": "published",
                                                "change_note": "Added the medical page.",
                                                "published_at": 1756339200,
                                                "retired_at": null,
                                                "record_count": 84,
                                                "previous_version_number": 2,
                                                "created_at": 1756335600,
                                                "updated_at": 1756339200
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/templates/7b1c4e92-3d58-4f07-9a26-8c5b0e14d3af/versions/3"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 2
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "template-versions-index-query",
                "tags": [
                    "Templates"
                ],
                "summary": "List template versions",
                "description": "List the versions of one template, newest first.\n\nEvery change to a structure produces a version rather than editing one, so this is the whole history of the template and the record of what was frozen when. A published version never changes again, which is what lets a record made a year ago go on rendering exactly as it did.\n\nAt most one version is a draft at a time. Publishing a later version does not change an earlier one, so several versions read as published and the template says which one is current. Each keeps its record_count for as long as anything is still on it.\n\nThis answers with the versions and not with what they contain. Read one version to get its pages, its sections and its fields.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "template",
                        "in": "path",
                        "required": true,
                        "description": "The id of the template. A path that is not a uuid answers 404 without a query being run, so neither the slug nor a sequential number reaches anything here.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "page": {
                                        "type": "integer",
                                        "default": 1,
                                        "description": "Which page to answer with."
                                    },
                                    "per_page": {
                                        "type": "integer",
                                        "default": 25,
                                        "description": "How many one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "A page of version objects, newest first, and how many there are in all. A template belonging to somebody else answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The versions on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One version.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always structure_version. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "version_number": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "Which version this is within its template, counting from 1. It is what the address of this version takes, and what a change note refers to."
                                                            },
                                                            "status": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Either draft or published. A draft is still being designed and may be changed freely. A published version is frozen and never changes again, and stays published after a later version replaces it, so read published_version_number on the template to know which one a new record is put on."
                                                            },
                                                            "change_note": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What changed since the version before, written when this one was published, or null on a draft and on the first version of a template. It is what somebody deciding whether to move their records reads."
                                                            },
                                                            "published_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the version was frozen, as a count of seconds, or null while it is a draft."
                                                            },
                                                            "retired_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "Always null. Publishing a later version does not retire the one it replaces, because the records still on it go on working exactly as they did."
                                                            },
                                                            "record_count": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How many records point at this precise version. A record follows the version it was put on until somebody moves it deliberately, so a retired version keeps a count above zero for as long as anything is still on it."
                                                            },
                                                            "previous_version_number": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "The number of the version this one was started from, or null on the first version of a template."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the version was started, as a count of seconds."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes. A published version never changes, so this stops moving at publication."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "structure_version",
                                            "id": "318",
                                            "attributes": {
                                                "version_number": 4,
                                                "status": "draft",
                                                "change_note": null,
                                                "published_at": null,
                                                "retired_at": null,
                                                "record_count": 0,
                                                "previous_version_number": 3,
                                                "created_at": 1756425600,
                                                "updated_at": 1756425600
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/templates/7b1c4e92-3d58-4f07-9a26-8c5b0e14d3af/versions/4"
                                            }
                                        },
                                        {
                                            "type": "structure_version",
                                            "id": "312",
                                            "attributes": {
                                                "version_number": 3,
                                                "status": "published",
                                                "change_note": "Added the medical page.",
                                                "published_at": 1756339200,
                                                "retired_at": null,
                                                "record_count": 84,
                                                "previous_version_number": 2,
                                                "created_at": 1756335600,
                                                "updated_at": 1756339200
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/templates/7b1c4e92-3d58-4f07-9a26-8c5b0e14d3af/versions/3"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 2
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "post": {
                "operationId": "template-versions-create",
                "tags": [
                    "Templates"
                ],
                "summary": "Open a draft",
                "description": "Start a draft of a template, copied from the version it is published at.\n\nA published version never changes again, so changing a structure means opening a draft beside it and working there. The draft arrives carrying a copy of the pages, the section placements and the fields of the version it came from, and the published version goes on serving every record exactly as before until you publish.\n\nA template has at most one draft at a time. Asking again while one is open answers with that draft and 200 rather than starting a second, so a client that retries a request it is unsure about cannot end up with two.\n\nThe draft is copied from the published version when there is one, and from the newest version otherwise. A template with no version at all has nothing to copy and answers 404.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "template",
                        "in": "path",
                        "required": true,
                        "description": "The id of the template. A path that is not a uuid answers 404 without a query being run, so neither the slug nor a sequential number reaches anything here.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "201": {
                        "description": "The draft, with 201 when it was started and 200 when one was already open. A template belonging to somebody else answers 404, and so does one with no version to copy.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The version.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always structure_version. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "version_number": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Which version this is within its template, counting from 1. It is what the address of this version takes, and what a change note refers to."
                                                        },
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either draft or published. A draft is still being designed and may be changed freely. A published version is frozen and never changes again, and stays published after a later version replaces it, so read published_version_number on the template to know which one a new record is put on."
                                                        },
                                                        "change_note": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What changed since the version before, written when this one was published, or null on a draft and on the first version of a template. It is what somebody deciding whether to move their records reads."
                                                        },
                                                        "published_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the version was frozen, as a count of seconds, or null while it is a draft."
                                                        },
                                                        "retired_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Always null. Publishing a later version does not retire the one it replaces, because the records still on it go on working exactly as they did."
                                                        },
                                                        "record_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many records point at this precise version. A record follows the version it was put on until somebody moves it deliberately, so a retired version keeps a count above zero for as long as anything is still on it."
                                                        },
                                                        "previous_version_number": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The number of the version this one was started from, or null on the first version of a template."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the version was started, as a count of seconds."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes. A published version never changes, so this stops moving at publication."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "structure_version",
                                        "id": "318",
                                        "attributes": {
                                            "version_number": 4,
                                            "status": "draft",
                                            "change_note": null,
                                            "published_at": null,
                                            "retired_at": null,
                                            "record_count": 0,
                                            "previous_version_number": 3,
                                            "created_at": 1756425600,
                                            "updated_at": 1756425600
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/templates/7b1c4e92-3d58-4f07-9a26-8c5b0e14d3af/versions/4"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/templates/{template}/versions/{version}/publication": {
            "put": {
                "operationId": "template-versions-publication-update",
                "tags": [
                    "Templates"
                ],
                "summary": "Publish a version",
                "description": "Freeze a draft and make it the version a new record is put on.\n\nThis is the moment the structure stops moving. From here the version never changes again, and any further work starts another draft beside it. Records already on an earlier version stay on it and go on working exactly as they did, until somebody moves them deliberately.\n\nAny section the version carries that is still a draft is published along with it, since a frozen version cannot rest on something that is still moving.\n\nA change note is required from the second version of a template onwards, because it is what somebody deciding whether to move their records reads. The first version of a template needs none, having replaced nothing.\n\nA version with no page, or with a page that has nothing on it, is refused: a structure nobody can fill is not one.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "template",
                        "in": "path",
                        "required": true,
                        "description": "The id of the template. A path that is not a uuid answers 404 without a query being run, so neither the slug nor a sequential number reaches anything here.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "version",
                        "in": "path",
                        "required": true,
                        "description": "The number of the version within its template, counting from 1, which is the number shown in the version history and the number a change note refers to. It is not a row id, so version 1 of one template and version 1 of another are different things reached through different templates.",
                        "schema": {
                            "type": "integer"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "change_note": {
                                        "type": "string",
                                        "description": "What changed since the version before. Up to 65535 characters. Required from the second version of a template onwards."
                                    }
                                }
                            },
                            "example": {
                                "change_note": "Added the medical page."
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The version, now published. A version that is not a draft answers 422, and so does one with an empty page or no page at all. A template belonging to somebody else answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The version.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always structure_version. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "version_number": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Which version this is within its template, counting from 1. It is what the address of this version takes, and what a change note refers to."
                                                        },
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either draft or published. A draft is still being designed and may be changed freely. A published version is frozen and never changes again, and stays published after a later version replaces it, so read published_version_number on the template to know which one a new record is put on."
                                                        },
                                                        "change_note": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What changed since the version before, written when this one was published, or null on a draft and on the first version of a template. It is what somebody deciding whether to move their records reads."
                                                        },
                                                        "published_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the version was frozen, as a count of seconds, or null while it is a draft."
                                                        },
                                                        "retired_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Always null. Publishing a later version does not retire the one it replaces, because the records still on it go on working exactly as they did."
                                                        },
                                                        "record_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many records point at this precise version. A record follows the version it was put on until somebody moves it deliberately, so a retired version keeps a count above zero for as long as anything is still on it."
                                                        },
                                                        "previous_version_number": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The number of the version this one was started from, or null on the first version of a template."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the version was started, as a count of seconds."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes. A published version never changes, so this stops moving at publication."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "structure_version",
                                        "id": "312",
                                        "attributes": {
                                            "version_number": 3,
                                            "status": "published",
                                            "change_note": "Added the medical page.",
                                            "published_at": 1756339200,
                                            "retired_at": null,
                                            "record_count": 84,
                                            "previous_version_number": 2,
                                            "created_at": 1756335600,
                                            "updated_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/templates/7b1c4e92-3d58-4f07-9a26-8c5b0e14d3af/versions/3"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/templates/{template}/versions/{version}": {
            "delete": {
                "operationId": "template-versions-destroy",
                "tags": [
                    "Templates"
                ],
                "summary": "Throw a draft away",
                "description": "Discard a draft and everything laid out in it.\n\nOnly a draft can be thrown away. A version that has been published is refused, because records point at it and the promise that a published version goes on working is the whole of the versioning design. Stop offering the template instead if you want it out of the way.\n\nNothing that was published changes, and the number the draft held is not given out again.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "template",
                        "in": "path",
                        "required": true,
                        "description": "The id of the template. A path that is not a uuid answers 404 without a query being run, so neither the slug nor a sequential number reaches anything here.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "version",
                        "in": "path",
                        "required": true,
                        "description": "The number of the version within its template, counting from 1, which is the number shown in the version history and the number a change note refers to. It is not a row id, so version 1 of one template and version 1 of another are different things reached through different templates.",
                        "schema": {
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Nothing. A version that is not a draft answers 422, and a template belonging to somebody else answers 404."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "get": {
                "operationId": "template-versions-show",
                "tags": [
                    "Templates"
                ],
                "summary": "Get a template version",
                "description": "Retrieve one version and everything it is made of: its pages, the sections placed on each, and the fields of each section.\n\nThis is the endpoint that tells you what a record means. A record names the version it sits on, and this answers with the structure that version froze, so a client can render the record without guessing what any of its values are for.\n\nThe whole structure comes back in one answer rather than a page at a time. A structure is one document, and splitting it would make it unreadable.\n\nThe version is named by its number within its template, which is the number the version history shows, and not by a row id. Version 3 of one template and version 3 of another are different things reached through different templates.\n\nA section is placed rather than owned. The same section can sit in several templates, and each placement names a precise version of it, which is what stops a change made through one template reaching another.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "template",
                        "in": "path",
                        "required": true,
                        "description": "The id of the template. A path that is not a uuid answers 404 without a query being run, so neither the slug nor a sequential number reaches anything here.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "version",
                        "in": "path",
                        "required": true,
                        "description": "The number of the version within its template, counting from 1, which is the number shown in the version history and the number a change note refers to. It is not a row id, so version 1 of one template and version 1 of another are different things reached through different templates.",
                        "schema": {
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A version object carrying its pages, their sections and their fields. A number the template does not have answers 404, and so does a template belonging to somebody else.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The version.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always structure_version. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "version_number": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Which version this is within its template, counting from 1. It is what the address of this version takes, and what a change note refers to."
                                                        },
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either draft or published. A draft is still being designed and may be changed freely. A published version is frozen and never changes again, and stays published after a later version replaces it, so read published_version_number on the template to know which one a new record is put on."
                                                        },
                                                        "change_note": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What changed since the version before, written when this one was published, or null on a draft and on the first version of a template. It is what somebody deciding whether to move their records reads."
                                                        },
                                                        "published_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the version was frozen, as a count of seconds, or null while it is a draft."
                                                        },
                                                        "retired_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Always null. Publishing a later version does not retire the one it replaces, because the records still on it go on working exactly as they did."
                                                        },
                                                        "record_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many records point at this precise version. A record follows the version it was put on until somebody moves it deliberately, so a retired version keeps a count above zero for as long as anything is still on it."
                                                        },
                                                        "previous_version_number": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The number of the version this one was started from, or null on the first version of a template."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the version was started, as a count of seconds."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes. A published version never changes, so this stops moving at publication."
                                                        },
                                                        "pages": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The tabs the version is divided into, in the order they are shown. Present only when one version is read on its own, never in the list.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One page.",
                                                                "properties": {
                                                                    "type": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Always structure_version_page. It names the kind of record, so a caller holding several kinds can tell them apart."
                                                                    },
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The id of the page, as a string even when it reads as a number."
                                                                    },
                                                                    "attributes": {
                                                                        "type": [
                                                                            "object",
                                                                            "null"
                                                                        ],
                                                                        "description": "Everything the page holds.",
                                                                        "properties": {
                                                                            "key": {
                                                                                "type": [
                                                                                    "string",
                                                                                    "null"
                                                                                ],
                                                                                "description": "How the page is addressed in a browser link. It is settled when the page is added and survives every rename."
                                                                            },
                                                                            "label": {
                                                                                "type": [
                                                                                    "string",
                                                                                    "null"
                                                                                ],
                                                                                "description": "What the tab says. A page the product supplied answers with the label translated into your language."
                                                                            },
                                                                            "position": {
                                                                                "type": [
                                                                                    "integer",
                                                                                    "null"
                                                                                ],
                                                                                "description": "Where the tab sits, counting from 1."
                                                                            },
                                                                            "sections": {
                                                                                "type": [
                                                                                    "array",
                                                                                    "null"
                                                                                ],
                                                                                "description": "The blocks placed on this page, in the order they are shown.",
                                                                                "items": {
                                                                                    "type": [
                                                                                        "object",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "One placement.",
                                                                                    "properties": {
                                                                                        "type": {
                                                                                            "type": [
                                                                                                "string",
                                                                                                "null"
                                                                                            ],
                                                                                            "description": "Always structure_version_section. It names the kind of record, so a caller holding several kinds can tell them apart."
                                                                                        },
                                                                                        "id": {
                                                                                            "type": [
                                                                                                "string",
                                                                                                "null"
                                                                                            ],
                                                                                            "description": "The id of the placement, as a string even when it reads as a number."
                                                                                        },
                                                                                        "attributes": {
                                                                                            "type": [
                                                                                                "object",
                                                                                                "null"
                                                                                            ],
                                                                                            "description": "Everything the placement holds.",
                                                                                            "properties": {
                                                                                                "position": {
                                                                                                    "type": [
                                                                                                        "integer",
                                                                                                        "null"
                                                                                                    ],
                                                                                                    "description": "Where the block sits on its page, counting from 1 again on each page."
                                                                                                },
                                                                                                "title": {
                                                                                                    "type": [
                                                                                                        "string",
                                                                                                        "null"
                                                                                                    ],
                                                                                                    "description": "What the block is headed: the override when there is one, and the name of the section otherwise. It is what to show a reader."
                                                                                                },
                                                                                                "title_override": {
                                                                                                    "type": [
                                                                                                        "string",
                                                                                                        "null"
                                                                                                    ],
                                                                                                    "description": "The heading chosen for this placement alone, or null when the section name is used. What a section is called here belongs to the assembly rather than to the section."
                                                                                                },
                                                                                                "section_id": {
                                                                                                    "type": [
                                                                                                        "string",
                                                                                                        "null"
                                                                                                    ],
                                                                                                    "description": "The id of the reusable section behind the placement. The same section may appear in several templates and in several versions of one template."
                                                                                                },
                                                                                                "section_name": {
                                                                                                    "type": [
                                                                                                        "string",
                                                                                                        "null"
                                                                                                    ],
                                                                                                    "description": "What the section is called in the section library."
                                                                                                },
                                                                                                "section_version_number": {
                                                                                                    "type": [
                                                                                                        "integer",
                                                                                                        "null"
                                                                                                    ],
                                                                                                    "description": "Which version of the section is placed here. A placement names a version and not a section, which is what stops a change made through another template reaching this one."
                                                                                                },
                                                                                                "section_version_status": {
                                                                                                    "type": [
                                                                                                        "string",
                                                                                                        "null"
                                                                                                    ],
                                                                                                    "description": "One of draft, published or retired, for the section version rather than the template version. A template version cannot be published while a section it carries is still a draft."
                                                                                                },
                                                                                                "is_collapsed_by_default": {
                                                                                                    "type": [
                                                                                                        "boolean",
                                                                                                        "null"
                                                                                                    ],
                                                                                                    "description": "Whether the block starts folded shut when somebody opens the record."
                                                                                                },
                                                                                                "fields": {
                                                                                                    "type": [
                                                                                                        "array",
                                                                                                        "null"
                                                                                                    ],
                                                                                                    "description": "What the section collects, in the order it is shown. Fields belong to the section version, never to the section, which is what makes freezing reach all the way down.",
                                                                                                    "items": {
                                                                                                        "type": [
                                                                                                            "object",
                                                                                                            "null"
                                                                                                        ],
                                                                                                        "description": "One field.",
                                                                                                        "properties": {
                                                                                                            "type": {
                                                                                                                "type": [
                                                                                                                    "string",
                                                                                                                    "null"
                                                                                                                ],
                                                                                                                "description": "Always field. It names the kind of record, so a caller holding several kinds can tell them apart."
                                                                                                            },
                                                                                                            "id": {
                                                                                                                "type": [
                                                                                                                    "string",
                                                                                                                    "null"
                                                                                                                ],
                                                                                                                "description": "The id of the field, as a string even when it reads as a number."
                                                                                                            },
                                                                                                            "attributes": {
                                                                                                                "type": [
                                                                                                                    "object",
                                                                                                                    "null"
                                                                                                                ],
                                                                                                                "description": "Everything the field holds.",
                                                                                                                "properties": {
                                                                                                                    "key": {
                                                                                                                        "type": [
                                                                                                                            "string",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "How the field is named in an import or an export, settled when the field is added."
                                                                                                                    },
                                                                                                                    "type": {
                                                                                                                        "type": [
                                                                                                                            "string",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "What kind of thing the field holds: one of text, textarea, number, boolean, url, email, phone, select, multiselect, radio, date, recurring_date, duration (a whole number of minutes), relation, file, image, avatar, address, repeater, divider, heading or help. The last three carry no value and are there to lay the form out."
                                                                                                                    },
                                                                                                                    "label": {
                                                                                                                        "type": [
                                                                                                                            "string",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "What the field is called on the form."
                                                                                                                    },
                                                                                                                    "help_text": {
                                                                                                                        "type": [
                                                                                                                            "string",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "A sentence shown under the field, or null when there is none."
                                                                                                                    },
                                                                                                                    "placeholder": {
                                                                                                                        "type": [
                                                                                                                            "string",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "What the empty box shows as an example, or null."
                                                                                                                    },
                                                                                                                    "position": {
                                                                                                                        "type": [
                                                                                                                            "integer",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "Where the field sits in its section, counting from 1."
                                                                                                                    },
                                                                                                                    "is_required": {
                                                                                                                        "type": [
                                                                                                                            "boolean",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "Whether the record refuses to save without it."
                                                                                                                    },
                                                                                                                    "is_sensitive": {
                                                                                                                        "type": [
                                                                                                                            "boolean",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "Whether the value is hidden until somebody asks to see it."
                                                                                                                    },
                                                                                                                    "is_highlighted": {
                                                                                                                        "type": [
                                                                                                                            "boolean",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "Whether the value is repeated at the top of the record."
                                                                                                                    },
                                                                                                                    "is_unique": {
                                                                                                                        "type": [
                                                                                                                            "boolean",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "Whether two records of this template may hold the same value."
                                                                                                                    },
                                                                                                                    "is_identifying": {
                                                                                                                        "type": [
                                                                                                                            "boolean",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "Whether two records sharing this value are likely the same record, so the pair is proposed as a duplicate. Not the same as unique: a household can legitimately share one telephone number, and proposing a pair is right where refusing the value would be wrong."
                                                                                                                    },
                                                                                                                    "is_repeatable": {
                                                                                                                        "type": [
                                                                                                                            "boolean",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "Whether the field holds several values rather than one. It follows from the type and is settled when the field is added."
                                                                                                                    },
                                                                                                                    "repeat_min": {
                                                                                                                        "type": [
                                                                                                                            "integer",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "The fewest repetitions allowed, or null when there is no floor."
                                                                                                                    },
                                                                                                                    "repeat_max": {
                                                                                                                        "type": [
                                                                                                                            "integer",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "The most repetitions allowed, or null when there is no ceiling."
                                                                                                                    },
                                                                                                                    "repetition_order": {
                                                                                                                        "type": [
                                                                                                                            "string",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "How several values are ordered against each other, or null when the field holds one."
                                                                                                                    },
                                                                                                                    "options": {
                                                                                                                        "type": [
                                                                                                                            "object",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "Settings belonging to this kind of field alone, or null. What it holds depends on the type."
                                                                                                                    },
                                                                                                                    "validation": {
                                                                                                                        "type": [
                                                                                                                            "object",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "Extra rules a value has to satisfy, or null."
                                                                                                                    },
                                                                                                                    "default_value": {
                                                                                                                        "type": [
                                                                                                                            "object",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "What the field starts filled with, or null."
                                                                                                                    },
                                                                                                                    "relation_target": {
                                                                                                                        "type": [
                                                                                                                            "string",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "What a relation field points at, or null when the field is not a relation. It is settled when the field is added."
                                                                                                                    },
                                                                                                                    "created_at": {
                                                                                                                        "type": [
                                                                                                                            "integer",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "When the field was added, as a count of seconds since 1970."
                                                                                                                    },
                                                                                                                    "updated_at": {
                                                                                                                        "type": [
                                                                                                                            "integer",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "When it last changed, as a count of seconds, or null."
                                                                                                                    }
                                                                                                                }
                                                                                                            }
                                                                                                        }
                                                                                                    }
                                                                                                }
                                                                                            }
                                                                                        }
                                                                                    }
                                                                                }
                                                                            }
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "structure_version",
                                        "id": "312",
                                        "attributes": {
                                            "version_number": 3,
                                            "status": "published",
                                            "change_note": "Added the medical page.",
                                            "published_at": 1756339200,
                                            "retired_at": null,
                                            "record_count": 84,
                                            "previous_version_number": 2,
                                            "created_at": 1756335600,
                                            "updated_at": 1756339200,
                                            "pages": [
                                                {
                                                    "type": "structure_version_page",
                                                    "id": "a1f7b3c8-6e42-4d09-8b57-1c9e0f2a4d36",
                                                    "attributes": {
                                                        "key": "general",
                                                        "label": "General",
                                                        "position": 1,
                                                        "sections": [
                                                            {
                                                                "type": "structure_version_section",
                                                                "id": "904",
                                                                "attributes": {
                                                                    "position": 1,
                                                                    "title": "Where they live",
                                                                    "title_override": "Where they live",
                                                                    "section_id": "d5e8c012-9a34-4b76-8f21-3e7c5a0b1d94",
                                                                    "section_name": "Address",
                                                                    "section_version_number": 2,
                                                                    "section_version_status": "published",
                                                                    "is_collapsed_by_default": false,
                                                                    "fields": [
                                                                        {
                                                                            "type": "field",
                                                                            "id": "5521",
                                                                            "attributes": {
                                                                                "key": "street",
                                                                                "type": "text",
                                                                                "label": "Street",
                                                                                "help_text": null,
                                                                                "placeholder": "221B Baker Street",
                                                                                "position": 1,
                                                                                "is_required": false,
                                                                                "is_sensitive": false,
                                                                                "is_highlighted": false,
                                                                                "is_unique": false,
                                                                                "is_identifying": false,
                                                                                "is_repeatable": false,
                                                                                "repeat_min": null,
                                                                                "repeat_max": null,
                                                                                "repetition_order": null,
                                                                                "options": null,
                                                                                "validation": null,
                                                                                "default_value": null,
                                                                                "relation_target": null,
                                                                                "created_at": 1756335600,
                                                                                "updated_at": 1756335600
                                                                            }
                                                                        }
                                                                    ]
                                                                }
                                                            }
                                                        ]
                                                    }
                                                }
                                            ]
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/templates/7b1c4e92-3d58-4f07-9a26-8c5b0e14d3af/versions/3"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "template-versions-show-query",
                "tags": [
                    "Templates"
                ],
                "summary": "Get a template version",
                "description": "Retrieve one version and everything it is made of: its pages, the sections placed on each, and the fields of each section.\n\nThis is the endpoint that tells you what a record means. A record names the version it sits on, and this answers with the structure that version froze, so a client can render the record without guessing what any of its values are for.\n\nThe whole structure comes back in one answer rather than a page at a time. A structure is one document, and splitting it would make it unreadable.\n\nThe version is named by its number within its template, which is the number the version history shows, and not by a row id. Version 3 of one template and version 3 of another are different things reached through different templates.\n\nA section is placed rather than owned. The same section can sit in several templates, and each placement names a precise version of it, which is what stops a change made through one template reaching another.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "template",
                        "in": "path",
                        "required": true,
                        "description": "The id of the template. A path that is not a uuid answers 404 without a query being run, so neither the slug nor a sequential number reaches anything here.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "version",
                        "in": "path",
                        "required": true,
                        "description": "The number of the version within its template, counting from 1, which is the number shown in the version history and the number a change note refers to. It is not a row id, so version 1 of one template and version 1 of another are different things reached through different templates.",
                        "schema": {
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A version object carrying its pages, their sections and their fields. A number the template does not have answers 404, and so does a template belonging to somebody else.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The version.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always structure_version. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "version_number": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Which version this is within its template, counting from 1. It is what the address of this version takes, and what a change note refers to."
                                                        },
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either draft or published. A draft is still being designed and may be changed freely. A published version is frozen and never changes again, and stays published after a later version replaces it, so read published_version_number on the template to know which one a new record is put on."
                                                        },
                                                        "change_note": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What changed since the version before, written when this one was published, or null on a draft and on the first version of a template. It is what somebody deciding whether to move their records reads."
                                                        },
                                                        "published_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the version was frozen, as a count of seconds, or null while it is a draft."
                                                        },
                                                        "retired_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Always null. Publishing a later version does not retire the one it replaces, because the records still on it go on working exactly as they did."
                                                        },
                                                        "record_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many records point at this precise version. A record follows the version it was put on until somebody moves it deliberately, so a retired version keeps a count above zero for as long as anything is still on it."
                                                        },
                                                        "previous_version_number": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The number of the version this one was started from, or null on the first version of a template."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the version was started, as a count of seconds."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes. A published version never changes, so this stops moving at publication."
                                                        },
                                                        "pages": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The tabs the version is divided into, in the order they are shown. Present only when one version is read on its own, never in the list.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One page.",
                                                                "properties": {
                                                                    "type": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Always structure_version_page. It names the kind of record, so a caller holding several kinds can tell them apart."
                                                                    },
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The id of the page, as a string even when it reads as a number."
                                                                    },
                                                                    "attributes": {
                                                                        "type": [
                                                                            "object",
                                                                            "null"
                                                                        ],
                                                                        "description": "Everything the page holds.",
                                                                        "properties": {
                                                                            "key": {
                                                                                "type": [
                                                                                    "string",
                                                                                    "null"
                                                                                ],
                                                                                "description": "How the page is addressed in a browser link. It is settled when the page is added and survives every rename."
                                                                            },
                                                                            "label": {
                                                                                "type": [
                                                                                    "string",
                                                                                    "null"
                                                                                ],
                                                                                "description": "What the tab says. A page the product supplied answers with the label translated into your language."
                                                                            },
                                                                            "position": {
                                                                                "type": [
                                                                                    "integer",
                                                                                    "null"
                                                                                ],
                                                                                "description": "Where the tab sits, counting from 1."
                                                                            },
                                                                            "sections": {
                                                                                "type": [
                                                                                    "array",
                                                                                    "null"
                                                                                ],
                                                                                "description": "The blocks placed on this page, in the order they are shown.",
                                                                                "items": {
                                                                                    "type": [
                                                                                        "object",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "One placement.",
                                                                                    "properties": {
                                                                                        "type": {
                                                                                            "type": [
                                                                                                "string",
                                                                                                "null"
                                                                                            ],
                                                                                            "description": "Always structure_version_section. It names the kind of record, so a caller holding several kinds can tell them apart."
                                                                                        },
                                                                                        "id": {
                                                                                            "type": [
                                                                                                "string",
                                                                                                "null"
                                                                                            ],
                                                                                            "description": "The id of the placement, as a string even when it reads as a number."
                                                                                        },
                                                                                        "attributes": {
                                                                                            "type": [
                                                                                                "object",
                                                                                                "null"
                                                                                            ],
                                                                                            "description": "Everything the placement holds.",
                                                                                            "properties": {
                                                                                                "position": {
                                                                                                    "type": [
                                                                                                        "integer",
                                                                                                        "null"
                                                                                                    ],
                                                                                                    "description": "Where the block sits on its page, counting from 1 again on each page."
                                                                                                },
                                                                                                "title": {
                                                                                                    "type": [
                                                                                                        "string",
                                                                                                        "null"
                                                                                                    ],
                                                                                                    "description": "What the block is headed: the override when there is one, and the name of the section otherwise. It is what to show a reader."
                                                                                                },
                                                                                                "title_override": {
                                                                                                    "type": [
                                                                                                        "string",
                                                                                                        "null"
                                                                                                    ],
                                                                                                    "description": "The heading chosen for this placement alone, or null when the section name is used. What a section is called here belongs to the assembly rather than to the section."
                                                                                                },
                                                                                                "section_id": {
                                                                                                    "type": [
                                                                                                        "string",
                                                                                                        "null"
                                                                                                    ],
                                                                                                    "description": "The id of the reusable section behind the placement. The same section may appear in several templates and in several versions of one template."
                                                                                                },
                                                                                                "section_name": {
                                                                                                    "type": [
                                                                                                        "string",
                                                                                                        "null"
                                                                                                    ],
                                                                                                    "description": "What the section is called in the section library."
                                                                                                },
                                                                                                "section_version_number": {
                                                                                                    "type": [
                                                                                                        "integer",
                                                                                                        "null"
                                                                                                    ],
                                                                                                    "description": "Which version of the section is placed here. A placement names a version and not a section, which is what stops a change made through another template reaching this one."
                                                                                                },
                                                                                                "section_version_status": {
                                                                                                    "type": [
                                                                                                        "string",
                                                                                                        "null"
                                                                                                    ],
                                                                                                    "description": "One of draft, published or retired, for the section version rather than the template version. A template version cannot be published while a section it carries is still a draft."
                                                                                                },
                                                                                                "is_collapsed_by_default": {
                                                                                                    "type": [
                                                                                                        "boolean",
                                                                                                        "null"
                                                                                                    ],
                                                                                                    "description": "Whether the block starts folded shut when somebody opens the record."
                                                                                                },
                                                                                                "fields": {
                                                                                                    "type": [
                                                                                                        "array",
                                                                                                        "null"
                                                                                                    ],
                                                                                                    "description": "What the section collects, in the order it is shown. Fields belong to the section version, never to the section, which is what makes freezing reach all the way down.",
                                                                                                    "items": {
                                                                                                        "type": [
                                                                                                            "object",
                                                                                                            "null"
                                                                                                        ],
                                                                                                        "description": "One field.",
                                                                                                        "properties": {
                                                                                                            "type": {
                                                                                                                "type": [
                                                                                                                    "string",
                                                                                                                    "null"
                                                                                                                ],
                                                                                                                "description": "Always field. It names the kind of record, so a caller holding several kinds can tell them apart."
                                                                                                            },
                                                                                                            "id": {
                                                                                                                "type": [
                                                                                                                    "string",
                                                                                                                    "null"
                                                                                                                ],
                                                                                                                "description": "The id of the field, as a string even when it reads as a number."
                                                                                                            },
                                                                                                            "attributes": {
                                                                                                                "type": [
                                                                                                                    "object",
                                                                                                                    "null"
                                                                                                                ],
                                                                                                                "description": "Everything the field holds.",
                                                                                                                "properties": {
                                                                                                                    "key": {
                                                                                                                        "type": [
                                                                                                                            "string",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "How the field is named in an import or an export, settled when the field is added."
                                                                                                                    },
                                                                                                                    "type": {
                                                                                                                        "type": [
                                                                                                                            "string",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "What kind of thing the field holds: one of text, textarea, number, boolean, url, email, phone, select, multiselect, radio, date, recurring_date, duration (a whole number of minutes), relation, file, image, avatar, address, repeater, divider, heading or help. The last three carry no value and are there to lay the form out."
                                                                                                                    },
                                                                                                                    "label": {
                                                                                                                        "type": [
                                                                                                                            "string",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "What the field is called on the form."
                                                                                                                    },
                                                                                                                    "help_text": {
                                                                                                                        "type": [
                                                                                                                            "string",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "A sentence shown under the field, or null when there is none."
                                                                                                                    },
                                                                                                                    "placeholder": {
                                                                                                                        "type": [
                                                                                                                            "string",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "What the empty box shows as an example, or null."
                                                                                                                    },
                                                                                                                    "position": {
                                                                                                                        "type": [
                                                                                                                            "integer",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "Where the field sits in its section, counting from 1."
                                                                                                                    },
                                                                                                                    "is_required": {
                                                                                                                        "type": [
                                                                                                                            "boolean",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "Whether the record refuses to save without it."
                                                                                                                    },
                                                                                                                    "is_sensitive": {
                                                                                                                        "type": [
                                                                                                                            "boolean",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "Whether the value is hidden until somebody asks to see it."
                                                                                                                    },
                                                                                                                    "is_highlighted": {
                                                                                                                        "type": [
                                                                                                                            "boolean",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "Whether the value is repeated at the top of the record."
                                                                                                                    },
                                                                                                                    "is_unique": {
                                                                                                                        "type": [
                                                                                                                            "boolean",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "Whether two records of this template may hold the same value."
                                                                                                                    },
                                                                                                                    "is_identifying": {
                                                                                                                        "type": [
                                                                                                                            "boolean",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "Whether two records sharing this value are likely the same record, so the pair is proposed as a duplicate. Not the same as unique: a household can legitimately share one telephone number, and proposing a pair is right where refusing the value would be wrong."
                                                                                                                    },
                                                                                                                    "is_repeatable": {
                                                                                                                        "type": [
                                                                                                                            "boolean",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "Whether the field holds several values rather than one. It follows from the type and is settled when the field is added."
                                                                                                                    },
                                                                                                                    "repeat_min": {
                                                                                                                        "type": [
                                                                                                                            "integer",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "The fewest repetitions allowed, or null when there is no floor."
                                                                                                                    },
                                                                                                                    "repeat_max": {
                                                                                                                        "type": [
                                                                                                                            "integer",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "The most repetitions allowed, or null when there is no ceiling."
                                                                                                                    },
                                                                                                                    "repetition_order": {
                                                                                                                        "type": [
                                                                                                                            "string",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "How several values are ordered against each other, or null when the field holds one."
                                                                                                                    },
                                                                                                                    "options": {
                                                                                                                        "type": [
                                                                                                                            "object",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "Settings belonging to this kind of field alone, or null. What it holds depends on the type."
                                                                                                                    },
                                                                                                                    "validation": {
                                                                                                                        "type": [
                                                                                                                            "object",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "Extra rules a value has to satisfy, or null."
                                                                                                                    },
                                                                                                                    "default_value": {
                                                                                                                        "type": [
                                                                                                                            "object",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "What the field starts filled with, or null."
                                                                                                                    },
                                                                                                                    "relation_target": {
                                                                                                                        "type": [
                                                                                                                            "string",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "What a relation field points at, or null when the field is not a relation. It is settled when the field is added."
                                                                                                                    },
                                                                                                                    "created_at": {
                                                                                                                        "type": [
                                                                                                                            "integer",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "When the field was added, as a count of seconds since 1970."
                                                                                                                    },
                                                                                                                    "updated_at": {
                                                                                                                        "type": [
                                                                                                                            "integer",
                                                                                                                            "null"
                                                                                                                        ],
                                                                                                                        "description": "When it last changed, as a count of seconds, or null."
                                                                                                                    }
                                                                                                                }
                                                                                                            }
                                                                                                        }
                                                                                                    }
                                                                                                }
                                                                                            }
                                                                                        }
                                                                                    }
                                                                                }
                                                                            }
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "structure_version",
                                        "id": "312",
                                        "attributes": {
                                            "version_number": 3,
                                            "status": "published",
                                            "change_note": "Added the medical page.",
                                            "published_at": 1756339200,
                                            "retired_at": null,
                                            "record_count": 84,
                                            "previous_version_number": 2,
                                            "created_at": 1756335600,
                                            "updated_at": 1756339200,
                                            "pages": [
                                                {
                                                    "type": "structure_version_page",
                                                    "id": "a1f7b3c8-6e42-4d09-8b57-1c9e0f2a4d36",
                                                    "attributes": {
                                                        "key": "general",
                                                        "label": "General",
                                                        "position": 1,
                                                        "sections": [
                                                            {
                                                                "type": "structure_version_section",
                                                                "id": "904",
                                                                "attributes": {
                                                                    "position": 1,
                                                                    "title": "Where they live",
                                                                    "title_override": "Where they live",
                                                                    "section_id": "d5e8c012-9a34-4b76-8f21-3e7c5a0b1d94",
                                                                    "section_name": "Address",
                                                                    "section_version_number": 2,
                                                                    "section_version_status": "published",
                                                                    "is_collapsed_by_default": false,
                                                                    "fields": [
                                                                        {
                                                                            "type": "field",
                                                                            "id": "5521",
                                                                            "attributes": {
                                                                                "key": "street",
                                                                                "type": "text",
                                                                                "label": "Street",
                                                                                "help_text": null,
                                                                                "placeholder": "221B Baker Street",
                                                                                "position": 1,
                                                                                "is_required": false,
                                                                                "is_sensitive": false,
                                                                                "is_highlighted": false,
                                                                                "is_unique": false,
                                                                                "is_identifying": false,
                                                                                "is_repeatable": false,
                                                                                "repeat_min": null,
                                                                                "repeat_max": null,
                                                                                "repetition_order": null,
                                                                                "options": null,
                                                                                "validation": null,
                                                                                "default_value": null,
                                                                                "relation_target": null,
                                                                                "created_at": 1756335600,
                                                                                "updated_at": 1756335600
                                                                            }
                                                                        }
                                                                    ]
                                                                }
                                                            }
                                                        ]
                                                    }
                                                }
                                            ]
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/templates/7b1c4e92-3d58-4f07-9a26-8c5b0e14d3af/versions/3"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/templates/{template}/versions/{version}/pages": {
            "post": {
                "operationId": "template-version-pages-create",
                "tags": [
                    "Templates"
                ],
                "summary": "Add a page",
                "description": "Add a tab to a draft.\n\nA page is a tab on the record, and it exists only inside the version that holds it. It cannot be reused, shared or published on its own, which is why it has no life outside the structure it is part of.\n\nThe key is settled here from the label and never rebuilt, so a browser link to the tab keeps working through any rename. Two pages of the same version cannot read the same thing.\n\nOnly a draft can be laid out. A version that has been published refuses this, and every other write below.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "template",
                        "in": "path",
                        "required": true,
                        "description": "The id of the template. A path that is not a uuid answers 404 without a query being run, so neither the slug nor a sequential number reaches anything here.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "version",
                        "in": "path",
                        "required": true,
                        "description": "The number of the version within its template, counting from 1, which is the number shown in the version history and the number a change note refers to. It is not a row id, so version 1 of one template and version 1 of another are different things reached through different templates.",
                        "schema": {
                            "type": "integer"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "label": {
                                        "type": "string",
                                        "description": "What the tab says. Up to 255 characters."
                                    },
                                    "key": {
                                        "type": "string",
                                        "description": "How the page is addressed in a browser link. Derived from the label when absent, and cleaned either way."
                                    }
                                },
                                "required": [
                                    "label"
                                ]
                            },
                            "example": {
                                "label": "Medical"
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The page that was added, placed last. A label another page of the version already reads answers 422.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The page.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always structure_version_page. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "key": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How the page is addressed in a browser link. It is settled when the page is added and survives every rename."
                                                        },
                                                        "label": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the tab says."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the tab sits, counting from 1."
                                                        },
                                                        "sections": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The blocks placed on this page. Empty here, since these endpoints answer with the page itself rather than with what is on it. Read the version to get the whole structure."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "structure_version_page",
                                        "id": "a1f7b3c8-6e42-4d09-8b57-1c9e0f2a4d36",
                                        "attributes": {
                                            "key": "medical",
                                            "label": "Medical",
                                            "position": 2,
                                            "sections": []
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/templates/{template}/versions/{version}/pages/{page}": {
            "put": {
                "operationId": "template-version-pages-update",
                "tags": [
                    "Templates"
                ],
                "summary": "Rename a page",
                "description": "Change what a tab says.\n\nThe key the page was settled is left alone, so a browser link that already went out keeps working. Only the wording moves.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "template",
                        "in": "path",
                        "required": true,
                        "description": "The id of the template. A path that is not a uuid answers 404 without a query being run, so neither the slug nor a sequential number reaches anything here.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "version",
                        "in": "path",
                        "required": true,
                        "description": "The number of the version within its template, counting from 1, which is the number shown in the version history and the number a change note refers to. It is not a row id, so version 1 of one template and version 1 of another are different things reached through different templates.",
                        "schema": {
                            "type": "integer"
                        }
                    },
                    {
                        "name": "page",
                        "in": "path",
                        "required": true,
                        "description": "The id of the page.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "label": {
                                        "type": "string",
                                        "description": "What the tab says. Up to 255 characters. It cannot be null."
                                    }
                                }
                            },
                            "example": {
                                "label": "Health"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The page as it now stands. A label another page of the version already reads answers 422.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The page.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always structure_version_page. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "key": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How the page is addressed in a browser link. It is settled when the page is added and survives every rename."
                                                        },
                                                        "label": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the tab says."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the tab sits, counting from 1."
                                                        },
                                                        "sections": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The blocks placed on this page. Empty here, since these endpoints answer with the page itself rather than with what is on it. Read the version to get the whole structure."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "structure_version_page",
                                        "id": "a1f7b3c8-6e42-4d09-8b57-1c9e0f2a4d36",
                                        "attributes": {
                                            "key": "medical",
                                            "label": "Medical",
                                            "position": 2,
                                            "sections": []
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "delete": {
                "operationId": "template-version-pages-destroy",
                "tags": [
                    "Templates"
                ],
                "summary": "Delete a page",
                "description": "Remove a tab that holds nothing.\n\nA page that still holds sections is refused, and the answer says how many. Take the sections off first, or move them to another page, so that nothing is lost by accident.\n\nThe last page of a version is refused too. A version with no page could not be published, and a structure nobody can fill is not one.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "template",
                        "in": "path",
                        "required": true,
                        "description": "The id of the template. A path that is not a uuid answers 404 without a query being run, so neither the slug nor a sequential number reaches anything here.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "version",
                        "in": "path",
                        "required": true,
                        "description": "The number of the version within its template, counting from 1, which is the number shown in the version history and the number a change note refers to. It is not a row id, so version 1 of one template and version 1 of another are different things reached through different templates.",
                        "schema": {
                            "type": "integer"
                        }
                    },
                    {
                        "name": "page",
                        "in": "path",
                        "required": true,
                        "description": "The id of the page.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Nothing. A page that still holds sections, and the last page of a version, both answer 422."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/templates/{template}/versions/{version}/pages/{page}/position": {
            "put": {
                "operationId": "template-version-pages-position-update",
                "tags": [
                    "Templates"
                ],
                "summary": "Move a page",
                "description": "Put a tab at a given place, counting from 1.\n\nEvery page of the version is numbered from 1 again afterwards, so the positions stay a run of whole numbers with no gaps. A place past the end puts the page last rather than being refused.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "template",
                        "in": "path",
                        "required": true,
                        "description": "The id of the template. A path that is not a uuid answers 404 without a query being run, so neither the slug nor a sequential number reaches anything here.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "version",
                        "in": "path",
                        "required": true,
                        "description": "The number of the version within its template, counting from 1, which is the number shown in the version history and the number a change note refers to. It is not a row id, so version 1 of one template and version 1 of another are different things reached through different templates.",
                        "schema": {
                            "type": "integer"
                        }
                    },
                    {
                        "name": "page",
                        "in": "path",
                        "required": true,
                        "description": "The id of the page.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "position": {
                                        "type": "integer",
                                        "description": "Where to put the page, counting from 1."
                                    }
                                },
                                "required": [
                                    "position"
                                ]
                            },
                            "example": {
                                "position": 1
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The page with the place it now holds.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The page.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always structure_version_page. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "key": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How the page is addressed in a browser link. It is settled when the page is added and survives every rename."
                                                        },
                                                        "label": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the tab says."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the tab sits, counting from 1."
                                                        },
                                                        "sections": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The blocks placed on this page. Empty here, since these endpoints answer with the page itself rather than with what is on it. Read the version to get the whole structure."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "structure_version_page",
                                        "id": "a1f7b3c8-6e42-4d09-8b57-1c9e0f2a4d36",
                                        "attributes": {
                                            "key": "medical",
                                            "label": "Medical",
                                            "position": 2,
                                            "sections": []
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/templates/{template}/versions/{version}/sections": {
            "post": {
                "operationId": "template-version-sections-create",
                "tags": [
                    "Templates"
                ],
                "summary": "Place a section",
                "description": "Put a section on a page of a draft, either one your account already has or a new one.\n\nSend section_id to place a section that already exists, or name to create a new one and place it in the same request. Send exactly one of the two. A section is reusable and belongs to your account rather than to a template, so the same one can sit in several templates and in several versions of one template, at a different place each time.\n\nA new section can only be created on a draft. On a published version the request is refused as invalid on version, and nothing is created.\n\nWhat is placed is a precise version of the section. Say which with section_version_number, or say nothing and the published version is used. That is what stops a change made through one template reaching another: a placement names a version, not a section.\n\nWhere it sits and what it is headed here belong to the placement rather than to the section, so overriding the title changes this template and nothing else. Name a page or leave it out to land on the first one.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "template",
                        "in": "path",
                        "required": true,
                        "description": "The id of the template. A path that is not a uuid answers 404 without a query being run, so neither the slug nor a sequential number reaches anything here.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "version",
                        "in": "path",
                        "required": true,
                        "description": "The number of the version within its template, counting from 1, which is the number shown in the version history and the number a change note refers to. It is not a row id, so version 1 of one template and version 1 of another are different things reached through different templates.",
                        "schema": {
                            "type": "integer"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "section_id": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "The section to place. Required when name is absent, refused alongside it. One belonging to somebody else is refused as invalid, and so is one already on this version."
                                    },
                                    "name": {
                                        "type": "string",
                                        "description": "The name of a new section to create and place. Required when section_id is absent, refused alongside it. At most 255 characters."
                                    },
                                    "icon": {
                                        "type": "string",
                                        "description": "The icon of a new section, only with name. One of profile, people, note, relationship, family, timeline, calendar, reminder, tasks, memory, journal, file, mail, phone, place, home, briefcase, organization, graduation, health, activity, ball, food, gift, pet, plane, globe, book, music, coin, car, target, tag, heart, star, lock, layers."
                                    },
                                    "colour": {
                                        "type": "string",
                                        "description": "The colour of a new section, only with name. One of #3f5fd0, #4f8a49, #9a6a24, #9a3f2b, #6b4fa8, #2f7f86, #a8447a, #4a4a52."
                                    },
                                    "section_version_number": {
                                        "type": "integer",
                                        "description": "Which version of the section to place, only with section_id. The published one when absent. A version that is no longer offered is refused."
                                    },
                                    "page_id": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "The page to place it on. The first page of the version when absent."
                                    },
                                    "title_override": {
                                        "type": "string",
                                        "description": "What to head the block here. The name of the section when absent."
                                    },
                                    "is_collapsed_by_default": {
                                        "type": "boolean",
                                        "description": "Whether the block starts folded shut. False when absent."
                                    }
                                }
                            },
                            "example": {
                                "section_id": "d5e8c012-9a34-4b76-8f21-3e7c5a0b1d94",
                                "title_override": "Where they live"
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The placement that was created, placed last on its page.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The placement.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always structure_version_section. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the block sits on its page, counting from 1 again on each page."
                                                        },
                                                        "title": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the block is headed: the override when there is one, and the name of the section otherwise. It is what to show a reader."
                                                        },
                                                        "title_override": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The heading chosen for this placement alone, or null when the section name is used. What a section is called here belongs to the assembly rather than to the section."
                                                        },
                                                        "section_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The id of the reusable section behind the placement. The same section may appear in several templates and in several versions of one template."
                                                        },
                                                        "section_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the section is called in the section library."
                                                        },
                                                        "section_version_number": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Which version of the section is placed here. A placement names a version and not a section, which is what stops a change made through another template reaching this one."
                                                        },
                                                        "section_version_status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of draft, published or retired, for the section version rather than the template version. A template version cannot be published while a section it carries is still a draft."
                                                        },
                                                        "is_collapsed_by_default": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the block starts folded shut when somebody opens the record."
                                                        },
                                                        "fields": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "What the section collects. Empty here, since these endpoints answer with the placement rather than with the section contents. Read the version to get the whole structure."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "structure_version_section",
                                        "id": "904",
                                        "attributes": {
                                            "position": 1,
                                            "title": "Where they live",
                                            "title_override": "Where they live",
                                            "section_id": "d5e8c012-9a34-4b76-8f21-3e7c5a0b1d94",
                                            "section_name": "Address",
                                            "section_version_number": 2,
                                            "section_version_status": "published",
                                            "is_collapsed_by_default": false,
                                            "fields": []
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/templates/{template}/versions/{version}/sections/{section}": {
            "put": {
                "operationId": "template-version-sections-update",
                "tags": [
                    "Templates"
                ],
                "summary": "Change a placement",
                "description": "Change what a block is headed here and whether it starts folded shut.\n\nThis touches the placement and never the section. The section keeps its name, its fields and its version, and every other template placing it is unaffected.\n\nSending title_override as null goes back to the name of the section.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "template",
                        "in": "path",
                        "required": true,
                        "description": "The id of the template. A path that is not a uuid answers 404 without a query being run, so neither the slug nor a sequential number reaches anything here.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "version",
                        "in": "path",
                        "required": true,
                        "description": "The number of the version within its template, counting from 1, which is the number shown in the version history and the number a change note refers to. It is not a row id, so version 1 of one template and version 1 of another are different things reached through different templates.",
                        "schema": {
                            "type": "integer"
                        }
                    },
                    {
                        "name": "section",
                        "in": "path",
                        "required": true,
                        "description": "The id of the placement, which is not the id of the section. It is the id a placement comes back with when a version is read.",
                        "schema": {
                            "type": "integer"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "title_override": {
                                        "type": "string",
                                        "description": "What to head the block here, or null to use the name of the section."
                                    },
                                    "is_collapsed_by_default": {
                                        "type": "boolean",
                                        "description": "Whether the block starts folded shut. It cannot be null."
                                    }
                                }
                            },
                            "example": {
                                "title_override": "Where they live"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The placement as it now stands.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The placement.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always structure_version_section. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the block sits on its page, counting from 1 again on each page."
                                                        },
                                                        "title": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the block is headed: the override when there is one, and the name of the section otherwise. It is what to show a reader."
                                                        },
                                                        "title_override": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The heading chosen for this placement alone, or null when the section name is used. What a section is called here belongs to the assembly rather than to the section."
                                                        },
                                                        "section_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The id of the reusable section behind the placement. The same section may appear in several templates and in several versions of one template."
                                                        },
                                                        "section_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the section is called in the section library."
                                                        },
                                                        "section_version_number": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Which version of the section is placed here. A placement names a version and not a section, which is what stops a change made through another template reaching this one."
                                                        },
                                                        "section_version_status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of draft, published or retired, for the section version rather than the template version. A template version cannot be published while a section it carries is still a draft."
                                                        },
                                                        "is_collapsed_by_default": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the block starts folded shut when somebody opens the record."
                                                        },
                                                        "fields": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "What the section collects. Empty here, since these endpoints answer with the placement rather than with the section contents. Read the version to get the whole structure."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "structure_version_section",
                                        "id": "904",
                                        "attributes": {
                                            "position": 1,
                                            "title": "Where they live",
                                            "title_override": "Where they live",
                                            "section_id": "d5e8c012-9a34-4b76-8f21-3e7c5a0b1d94",
                                            "section_name": "Address",
                                            "section_version_number": 2,
                                            "section_version_status": "published",
                                            "is_collapsed_by_default": false,
                                            "fields": []
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "delete": {
                "operationId": "template-version-sections-destroy",
                "tags": [
                    "Templates"
                ],
                "summary": "Take a section off",
                "description": "Remove a block from a draft.\n\nThis removes the placement. The section itself is untouched and goes on existing for every other template that places it, which is the whole point of a section being its own thing.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "template",
                        "in": "path",
                        "required": true,
                        "description": "The id of the template. A path that is not a uuid answers 404 without a query being run, so neither the slug nor a sequential number reaches anything here.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "version",
                        "in": "path",
                        "required": true,
                        "description": "The number of the version within its template, counting from 1, which is the number shown in the version history and the number a change note refers to. It is not a row id, so version 1 of one template and version 1 of another are different things reached through different templates.",
                        "schema": {
                            "type": "integer"
                        }
                    },
                    {
                        "name": "section",
                        "in": "path",
                        "required": true,
                        "description": "The id of the placement, which is not the id of the section. It is the id a placement comes back with when a version is read.",
                        "schema": {
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Nothing. A placement on a template belonging to somebody else answers 404."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/templates/{template}/versions/{version}/sections/{section}/position": {
            "put": {
                "operationId": "template-version-sections-position-update",
                "tags": [
                    "Templates"
                ],
                "summary": "Move a section on its page",
                "description": "Put a block at a given place on its page, counting from 1.\n\nPositions start again on each page, so this orders the block against the others on its own page and nothing else. Every one of them is numbered from 1 again afterwards, and a place past the end lands last.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "template",
                        "in": "path",
                        "required": true,
                        "description": "The id of the template. A path that is not a uuid answers 404 without a query being run, so neither the slug nor a sequential number reaches anything here.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "version",
                        "in": "path",
                        "required": true,
                        "description": "The number of the version within its template, counting from 1, which is the number shown in the version history and the number a change note refers to. It is not a row id, so version 1 of one template and version 1 of another are different things reached through different templates.",
                        "schema": {
                            "type": "integer"
                        }
                    },
                    {
                        "name": "section",
                        "in": "path",
                        "required": true,
                        "description": "The id of the placement, which is not the id of the section. It is the id a placement comes back with when a version is read.",
                        "schema": {
                            "type": "integer"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "position": {
                                        "type": "integer",
                                        "description": "Where to put the block on its page, counting from 1."
                                    }
                                },
                                "required": [
                                    "position"
                                ]
                            },
                            "example": {
                                "position": 1
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The placement with the place it now holds.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The placement.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always structure_version_section. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the block sits on its page, counting from 1 again on each page."
                                                        },
                                                        "title": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the block is headed: the override when there is one, and the name of the section otherwise. It is what to show a reader."
                                                        },
                                                        "title_override": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The heading chosen for this placement alone, or null when the section name is used. What a section is called here belongs to the assembly rather than to the section."
                                                        },
                                                        "section_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The id of the reusable section behind the placement. The same section may appear in several templates and in several versions of one template."
                                                        },
                                                        "section_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the section is called in the section library."
                                                        },
                                                        "section_version_number": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Which version of the section is placed here. A placement names a version and not a section, which is what stops a change made through another template reaching this one."
                                                        },
                                                        "section_version_status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of draft, published or retired, for the section version rather than the template version. A template version cannot be published while a section it carries is still a draft."
                                                        },
                                                        "is_collapsed_by_default": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the block starts folded shut when somebody opens the record."
                                                        },
                                                        "fields": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "What the section collects. Empty here, since these endpoints answer with the placement rather than with the section contents. Read the version to get the whole structure."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "structure_version_section",
                                        "id": "904",
                                        "attributes": {
                                            "position": 1,
                                            "title": "Where they live",
                                            "title_override": "Where they live",
                                            "section_id": "d5e8c012-9a34-4b76-8f21-3e7c5a0b1d94",
                                            "section_name": "Address",
                                            "section_version_number": 2,
                                            "section_version_status": "published",
                                            "is_collapsed_by_default": false,
                                            "fields": []
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/templates/{template}/versions/{version}/sections/{section}/page": {
            "put": {
                "operationId": "template-version-sections-page-update",
                "tags": [
                    "Templates"
                ],
                "summary": "Move a section to another page",
                "description": "Move a block from one tab of a draft to another.\n\nThe block lands last on the page it arrives at, and the page it left is numbered from 1 again. The section is untouched: only where it sits changes.\n\nThe page has to belong to the same version. One from another version, or another template, answers 404.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "template",
                        "in": "path",
                        "required": true,
                        "description": "The id of the template. A path that is not a uuid answers 404 without a query being run, so neither the slug nor a sequential number reaches anything here.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "version",
                        "in": "path",
                        "required": true,
                        "description": "The number of the version within its template, counting from 1, which is the number shown in the version history and the number a change note refers to. It is not a row id, so version 1 of one template and version 1 of another are different things reached through different templates.",
                        "schema": {
                            "type": "integer"
                        }
                    },
                    {
                        "name": "section",
                        "in": "path",
                        "required": true,
                        "description": "The id of the placement, which is not the id of the section. It is the id a placement comes back with when a version is read.",
                        "schema": {
                            "type": "integer"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "page_id": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "The page to move it to, which has to be a page of this version."
                                    }
                                },
                                "required": [
                                    "page_id"
                                ]
                            },
                            "example": {
                                "page_id": "a1f7b3c8-6e42-4d09-8b57-1c9e0f2a4d36"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The placement, now on its new page.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The placement.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always structure_version_section. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the block sits on its page, counting from 1 again on each page."
                                                        },
                                                        "title": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the block is headed: the override when there is one, and the name of the section otherwise. It is what to show a reader."
                                                        },
                                                        "title_override": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The heading chosen for this placement alone, or null when the section name is used. What a section is called here belongs to the assembly rather than to the section."
                                                        },
                                                        "section_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The id of the reusable section behind the placement. The same section may appear in several templates and in several versions of one template."
                                                        },
                                                        "section_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the section is called in the section library."
                                                        },
                                                        "section_version_number": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Which version of the section is placed here. A placement names a version and not a section, which is what stops a change made through another template reaching this one."
                                                        },
                                                        "section_version_status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of draft, published or retired, for the section version rather than the template version. A template version cannot be published while a section it carries is still a draft."
                                                        },
                                                        "is_collapsed_by_default": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the block starts folded shut when somebody opens the record."
                                                        },
                                                        "fields": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "What the section collects. Empty here, since these endpoints answer with the placement rather than with the section contents. Read the version to get the whole structure."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "structure_version_section",
                                        "id": "904",
                                        "attributes": {
                                            "position": 1,
                                            "title": "Where they live",
                                            "title_override": "Where they live",
                                            "section_id": "d5e8c012-9a34-4b76-8f21-3e7c5a0b1d94",
                                            "section_name": "Address",
                                            "section_version_number": 2,
                                            "section_version_status": "published",
                                            "is_collapsed_by_default": false,
                                            "fields": []
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/templates/{template}/versions/{version}/sections/{section}/fields": {
            "post": {
                "operationId": "fields-create",
                "tags": [
                    "Templates"
                ],
                "summary": "Add a field",
                "description": "Add a piece of data to a section, through the template that places it.\n\nFields belong to the section version rather than to the section, which is what makes freezing reach all the way down. So if the section placed here has been published, adding a field opens a draft of the section first and adds it there. The published section is untouched, and every other template placing it goes on exactly as before. The answer names the section version that took the change.\n\nThe type is settled here and cannot be changed afterwards, and so is what a relation points at and whether the field repeats, because records get written against those promises. Everything else can be changed later.\n\nA field offering choices has to say which value list they come from, and a relation field has to say what it points at. Three types carry no value at all and are there to lay the form out: divider, heading and help.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "template",
                        "in": "path",
                        "required": true,
                        "description": "The id of the template. A path that is not a uuid answers 404 without a query being run, so neither the slug nor a sequential number reaches anything here.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "version",
                        "in": "path",
                        "required": true,
                        "description": "The number of the version within its template, counting from 1, which is the number shown in the version history and the number a change note refers to. It is not a row id, so version 1 of one template and version 1 of another are different things reached through different templates.",
                        "schema": {
                            "type": "integer"
                        }
                    },
                    {
                        "name": "section",
                        "in": "path",
                        "required": true,
                        "description": "The id of the placement, which is not the id of the section. It is the id a placement comes back with when a version is read.",
                        "schema": {
                            "type": "integer"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "type": {
                                        "type": "string",
                                        "description": "What kind of thing the field holds: one of text, textarea, number, boolean, url, email, phone, select, multiselect, radio, date, recurring_date, duration (a whole number of minutes), relation, file, image, avatar, address, repeater, divider, heading or help."
                                    },
                                    "label": {
                                        "type": "string",
                                        "description": "What the field is called on the form. Up to 255 characters."
                                    },
                                    "key": {
                                        "type": "string",
                                        "description": "How the field is named in an import or an export. Derived from the label when absent, and settled once."
                                    },
                                    "value_list_id": {
                                        "type": "integer",
                                        "description": "The list a field offering choices takes them from, as the id the value lists endpoint gives. Required for select, multiselect and radio."
                                    },
                                    "relation_target": {
                                        "type": "string",
                                        "description": "What a relation field points at: contact or entity. Required for a relation field."
                                    },
                                    "relation_entity_type_id": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "Which kind of entity a relation field points at. Required when relation_target is entity."
                                    },
                                    "parent_id": {
                                        "type": "integer",
                                        "description": "The repeater this field sits inside. Only a repeater can hold other fields, and a repeater cannot sit inside another."
                                    }
                                },
                                "required": [
                                    "type",
                                    "label"
                                ]
                            },
                            "example": {
                                "type": "text",
                                "label": "Nickname"
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The field that was added, placed last in its section, with every setting at its default.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The field.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always field. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "key": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How the field is named in an import or an export, settled when the field is added."
                                                        },
                                                        "type": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What kind of thing the field holds: one of text, textarea, number, boolean, url, email, phone, select, multiselect, radio, date, recurring_date, duration (a whole number of minutes), relation, file, image, avatar, address, repeater, divider, heading or help. The last three carry no value and are there to lay the form out."
                                                        },
                                                        "label": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the field is called on the form."
                                                        },
                                                        "help_text": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "A sentence shown under the field, or null when there is none."
                                                        },
                                                        "placeholder": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the empty box shows as an example, or null."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the field sits in its section, counting from 1."
                                                        },
                                                        "is_required": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the record refuses to save without it."
                                                        },
                                                        "is_sensitive": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the value is hidden until somebody asks to see it."
                                                        },
                                                        "is_highlighted": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the value is repeated at the top of the record."
                                                        },
                                                        "is_unique": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether two records of this template may hold the same value."
                                                        },
                                                        "is_identifying": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether two records sharing this value are likely the same record, so the pair is proposed as a duplicate. Not the same as unique: a household can legitimately share one telephone number, and proposing a pair is right where refusing the value would be wrong."
                                                        },
                                                        "is_repeatable": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the field holds several values rather than one. It follows from the type and is settled when the field is added."
                                                        },
                                                        "repeat_min": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The fewest repetitions allowed, or null when there is no floor."
                                                        },
                                                        "repeat_max": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The most repetitions allowed, or null when there is no ceiling."
                                                        },
                                                        "repetition_order": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How several values are ordered against each other, or null when the field holds one."
                                                        },
                                                        "options": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "Settings belonging to this kind of field alone, or null. What it holds depends on the type."
                                                        },
                                                        "validation": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "Extra rules a value has to satisfy, or null."
                                                        },
                                                        "default_value": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "What the field starts filled with, or null."
                                                        },
                                                        "relation_target": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What a relation field points at, or null when the field is not a relation. It is settled when the field is added."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the field was added, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "field",
                                        "id": "5521",
                                        "attributes": {
                                            "key": "nickname",
                                            "type": "text",
                                            "label": "Nickname",
                                            "help_text": null,
                                            "placeholder": null,
                                            "position": 1,
                                            "is_required": false,
                                            "is_sensitive": false,
                                            "is_highlighted": false,
                                            "is_unique": false,
                                            "is_identifying": false,
                                            "is_repeatable": false,
                                            "repeat_min": null,
                                            "repeat_max": null,
                                            "repetition_order": null,
                                            "options": null,
                                            "validation": null,
                                            "default_value": null,
                                            "relation_target": null,
                                            "created_at": 1756335600,
                                            "updated_at": 1756335600
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/templates/{template}/versions/{version}/sections/{section}/fields/{field}": {
            "put": {
                "operationId": "fields-update",
                "tags": [
                    "Templates"
                ],
                "summary": "Configure a field",
                "description": "Change what a field is called and how it behaves.\n\nAs with adding one, changing a field of a section that has been published opens a draft of the section and changes it there, leaving the published section and every other template placing it alone.\n\nThe type, whether the field repeats, and what a relation points at are settled when the field is added and are not sent here. Everything else may be sent: a setting left out keeps its value, and a setting sent as null goes back to its default. The label and the five switches cannot be null.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "template",
                        "in": "path",
                        "required": true,
                        "description": "The id of the template. A path that is not a uuid answers 404 without a query being run, so neither the slug nor a sequential number reaches anything here.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "version",
                        "in": "path",
                        "required": true,
                        "description": "The number of the version within its template, counting from 1, which is the number shown in the version history and the number a change note refers to. It is not a row id, so version 1 of one template and version 1 of another are different things reached through different templates.",
                        "schema": {
                            "type": "integer"
                        }
                    },
                    {
                        "name": "section",
                        "in": "path",
                        "required": true,
                        "description": "The id of the placement, which is not the id of the section. It is the id a placement comes back with when a version is read.",
                        "schema": {
                            "type": "integer"
                        }
                    },
                    {
                        "name": "field",
                        "in": "path",
                        "required": true,
                        "description": "The id of the field. It changes the first time a published section is changed, because the change opens a draft of the section and the fields are copied into it. The key does not change, and the answer carries the new id.",
                        "schema": {
                            "type": "integer"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "label": {
                                        "type": "string",
                                        "description": "What the field is called on the form. It cannot be null."
                                    },
                                    "help_text": {
                                        "type": "string",
                                        "description": "A sentence shown under the field, or null to remove it."
                                    },
                                    "placeholder": {
                                        "type": "string",
                                        "description": "What the empty box shows as an example, or null to remove it."
                                    },
                                    "is_required": {
                                        "type": "boolean",
                                        "description": "Whether the record refuses to save without it."
                                    },
                                    "is_sensitive": {
                                        "type": "boolean",
                                        "description": "Whether the value is hidden until somebody asks to see it."
                                    },
                                    "is_highlighted": {
                                        "type": "boolean",
                                        "description": "Whether the value is repeated at the top of the record."
                                    },
                                    "is_unique": {
                                        "type": "boolean",
                                        "description": "Whether two records may hold the same value."
                                    },
                                    "is_identifying": {
                                        "type": "boolean",
                                        "description": "Whether two records sharing this value are likely the same record, so the pair is proposed as a duplicate."
                                    },
                                    "value_list_id": {
                                        "type": "integer",
                                        "description": "The list a field offering choices takes them from, as the id the value lists endpoint gives. A list of another account is refused. Null removes it."
                                    },
                                    "default_value": {
                                        "type": "object",
                                        "description": "What the field starts filled with."
                                    },
                                    "options": {
                                        "type": "object",
                                        "description": "Settings belonging to this kind of field alone. A file or image field takes accepted_mime_types, a list of at most 20 mime types such as image/png, and an image field takes image types only. Anything else answers 422 on options."
                                    },
                                    "validation": {
                                        "type": "object",
                                        "description": "Extra rules a value has to satisfy."
                                    },
                                    "repeat_min": {
                                        "type": "integer",
                                        "description": "The fewest repetitions allowed."
                                    },
                                    "repeat_max": {
                                        "type": "integer",
                                        "description": "The most repetitions allowed."
                                    },
                                    "repetition_order": {
                                        "type": "string",
                                        "description": "How several values are ordered: newest_last or newest_first."
                                    }
                                }
                            },
                            "example": {
                                "label": "Street name",
                                "help_text": "Including the number.",
                                "placeholder": "221B Baker Street"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The field as it now stands, carrying the id it holds in the section version that took the change.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The field.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always field. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "key": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How the field is named in an import or an export, settled when the field is added."
                                                        },
                                                        "type": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What kind of thing the field holds: one of text, textarea, number, boolean, url, email, phone, select, multiselect, radio, date, recurring_date, duration (a whole number of minutes), relation, file, image, avatar, address, repeater, divider, heading or help. The last three carry no value and are there to lay the form out."
                                                        },
                                                        "label": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the field is called on the form."
                                                        },
                                                        "help_text": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "A sentence shown under the field, or null when there is none."
                                                        },
                                                        "placeholder": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the empty box shows as an example, or null."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the field sits in its section, counting from 1."
                                                        },
                                                        "is_required": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the record refuses to save without it."
                                                        },
                                                        "is_sensitive": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the value is hidden until somebody asks to see it."
                                                        },
                                                        "is_highlighted": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the value is repeated at the top of the record."
                                                        },
                                                        "is_unique": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether two records of this template may hold the same value."
                                                        },
                                                        "is_identifying": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether two records sharing this value are likely the same record, so the pair is proposed as a duplicate. Not the same as unique: a household can legitimately share one telephone number, and proposing a pair is right where refusing the value would be wrong."
                                                        },
                                                        "is_repeatable": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the field holds several values rather than one. It follows from the type and is settled when the field is added."
                                                        },
                                                        "repeat_min": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The fewest repetitions allowed, or null when there is no floor."
                                                        },
                                                        "repeat_max": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The most repetitions allowed, or null when there is no ceiling."
                                                        },
                                                        "repetition_order": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How several values are ordered against each other, or null when the field holds one."
                                                        },
                                                        "options": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "Settings belonging to this kind of field alone, or null. What it holds depends on the type."
                                                        },
                                                        "validation": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "Extra rules a value has to satisfy, or null."
                                                        },
                                                        "default_value": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "What the field starts filled with, or null."
                                                        },
                                                        "relation_target": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What a relation field points at, or null when the field is not a relation. It is settled when the field is added."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the field was added, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "field",
                                        "id": "5521",
                                        "attributes": {
                                            "key": "nickname",
                                            "type": "text",
                                            "label": "Nickname",
                                            "help_text": null,
                                            "placeholder": null,
                                            "position": 1,
                                            "is_required": false,
                                            "is_sensitive": false,
                                            "is_highlighted": false,
                                            "is_unique": false,
                                            "is_identifying": false,
                                            "is_repeatable": false,
                                            "repeat_min": null,
                                            "repeat_max": null,
                                            "repetition_order": null,
                                            "options": null,
                                            "validation": null,
                                            "default_value": null,
                                            "relation_target": null,
                                            "created_at": 1756335600,
                                            "updated_at": 1756335600
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "delete": {
                "operationId": "fields-destroy",
                "tags": [
                    "Templates"
                ],
                "summary": "Remove a field",
                "description": "Take a field out of a section.\n\nThe values already written under the field are not destroyed. They are detached and kept, so nothing a person typed disappears because somebody changed a structure, and a field put back finds them again.\n\nAs with the other two, a published section is drafted first and the published one is left alone.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "template",
                        "in": "path",
                        "required": true,
                        "description": "The id of the template. A path that is not a uuid answers 404 without a query being run, so neither the slug nor a sequential number reaches anything here.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "version",
                        "in": "path",
                        "required": true,
                        "description": "The number of the version within its template, counting from 1, which is the number shown in the version history and the number a change note refers to. It is not a row id, so version 1 of one template and version 1 of another are different things reached through different templates.",
                        "schema": {
                            "type": "integer"
                        }
                    },
                    {
                        "name": "section",
                        "in": "path",
                        "required": true,
                        "description": "The id of the placement, which is not the id of the section. It is the id a placement comes back with when a version is read.",
                        "schema": {
                            "type": "integer"
                        }
                    },
                    {
                        "name": "field",
                        "in": "path",
                        "required": true,
                        "description": "The id of the field. It changes the first time a published section is changed, because the change opens a draft of the section and the fields are copied into it. The key does not change, and the answer carries the new id.",
                        "schema": {
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Nothing. A field of a template belonging to somebody else answers 404."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/templates/{template}/versions/{version}/sections/{section}/fields/{field}/position": {
            "put": {
                "operationId": "fields-position-update",
                "tags": [
                    "Templates"
                ],
                "summary": "Move a field",
                "description": "Put a field at a given place in its section, counting from 1.\n\nEvery field of the section is numbered from 1 again afterwards, and a place past the end lands last. A published section is drafted first, exactly as it is for the other changes to a field.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "template",
                        "in": "path",
                        "required": true,
                        "description": "The id of the template. A path that is not a uuid answers 404 without a query being run, so neither the slug nor a sequential number reaches anything here.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "version",
                        "in": "path",
                        "required": true,
                        "description": "The number of the version within its template, counting from 1, which is the number shown in the version history and the number a change note refers to. It is not a row id, so version 1 of one template and version 1 of another are different things reached through different templates.",
                        "schema": {
                            "type": "integer"
                        }
                    },
                    {
                        "name": "section",
                        "in": "path",
                        "required": true,
                        "description": "The id of the placement, which is not the id of the section. It is the id a placement comes back with when a version is read.",
                        "schema": {
                            "type": "integer"
                        }
                    },
                    {
                        "name": "field",
                        "in": "path",
                        "required": true,
                        "description": "The id of the field. It changes the first time a published section is changed, because the change opens a draft of the section and the fields are copied into it. The key does not change, and the answer carries the new id.",
                        "schema": {
                            "type": "integer"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "position": {
                                        "type": "integer",
                                        "description": "Where to put the field in its section, counting from 1."
                                    }
                                },
                                "required": [
                                    "position"
                                ]
                            },
                            "example": {
                                "position": 1
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The field with the place it now holds.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The field.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always field. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "key": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How the field is named in an import or an export, settled when the field is added."
                                                        },
                                                        "type": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What kind of thing the field holds: one of text, textarea, number, boolean, url, email, phone, select, multiselect, radio, date, recurring_date, duration (a whole number of minutes), relation, file, image, avatar, address, repeater, divider, heading or help. The last three carry no value and are there to lay the form out."
                                                        },
                                                        "label": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the field is called on the form."
                                                        },
                                                        "help_text": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "A sentence shown under the field, or null when there is none."
                                                        },
                                                        "placeholder": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the empty box shows as an example, or null."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the field sits in its section, counting from 1."
                                                        },
                                                        "is_required": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the record refuses to save without it."
                                                        },
                                                        "is_sensitive": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the value is hidden until somebody asks to see it."
                                                        },
                                                        "is_highlighted": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the value is repeated at the top of the record."
                                                        },
                                                        "is_unique": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether two records of this template may hold the same value."
                                                        },
                                                        "is_identifying": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether two records sharing this value are likely the same record, so the pair is proposed as a duplicate. Not the same as unique: a household can legitimately share one telephone number, and proposing a pair is right where refusing the value would be wrong."
                                                        },
                                                        "is_repeatable": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the field holds several values rather than one. It follows from the type and is settled when the field is added."
                                                        },
                                                        "repeat_min": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The fewest repetitions allowed, or null when there is no floor."
                                                        },
                                                        "repeat_max": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The most repetitions allowed, or null when there is no ceiling."
                                                        },
                                                        "repetition_order": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How several values are ordered against each other, or null when the field holds one."
                                                        },
                                                        "options": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "Settings belonging to this kind of field alone, or null. What it holds depends on the type."
                                                        },
                                                        "validation": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "Extra rules a value has to satisfy, or null."
                                                        },
                                                        "default_value": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "What the field starts filled with, or null."
                                                        },
                                                        "relation_target": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What a relation field points at, or null when the field is not a relation. It is settled when the field is added."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the field was added, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "field",
                                        "id": "5521",
                                        "attributes": {
                                            "key": "nickname",
                                            "type": "text",
                                            "label": "Nickname",
                                            "help_text": null,
                                            "placeholder": null,
                                            "position": 1,
                                            "is_required": false,
                                            "is_sensitive": false,
                                            "is_highlighted": false,
                                            "is_unique": false,
                                            "is_identifying": false,
                                            "is_repeatable": false,
                                            "repeat_min": null,
                                            "repeat_max": null,
                                            "repetition_order": null,
                                            "options": null,
                                            "validation": null,
                                            "default_value": null,
                                            "relation_target": null,
                                            "created_at": 1756335600,
                                            "updated_at": 1756335600
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/value-lists": {
            "get": {
                "operationId": "value-lists-index",
                "tags": [
                    "Templates"
                ],
                "summary": "List value lists",
                "description": "List the value lists of your account, each with its choices, so a field offering choices can name the one it takes them from.\n\nA value list is a named set of choices defined once for the account and reused by any number of fields: genders, phone labels, contact categories. The lists are in the order the settings show them, and the choices of each in their own order.\n\nOnly the shared lists are here. The choices somebody typed into a single field belong to that field and are not listed.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to answer with.",
                        "schema": {
                            "type": "integer",
                            "default": 1
                        }
                    },
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "How many one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused.",
                        "schema": {
                            "type": "integer",
                            "default": 25
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of value lists, and how many there are in all. The lists of another account are never included.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The value lists on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One value list.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always value_list."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "integer",
                                                            "null"
                                                        ],
                                                        "description": "The id of the list, which is what value_list_id takes when a field is added or configured."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "What the list holds.",
                                                        "properties": {
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the list is called."
                                                            },
                                                            "items": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "The choices the list offers, in their order. An empty list when it offers none yet.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One choice.",
                                                                    "properties": {
                                                                        "id": {
                                                                            "type": [
                                                                                "integer",
                                                                                "null"
                                                                            ],
                                                                            "description": "The id of the choice, which is what a field offering this list stores as its value."
                                                                        },
                                                                        "label": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "What the choice says."
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "value_list",
                                            "id": 3,
                                            "attributes": {
                                                "name": "Genders",
                                                "items": [
                                                    {
                                                        "id": 11,
                                                        "label": "Woman"
                                                    },
                                                    {
                                                        "id": 12,
                                                        "label": "Man"
                                                    },
                                                    {
                                                        "id": 13,
                                                        "label": "Non-binary"
                                                    }
                                                ]
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "value-lists-index-query",
                "tags": [
                    "Templates"
                ],
                "summary": "List value lists",
                "description": "List the value lists of your account, each with its choices, so a field offering choices can name the one it takes them from.\n\nA value list is a named set of choices defined once for the account and reused by any number of fields: genders, phone labels, contact categories. The lists are in the order the settings show them, and the choices of each in their own order.\n\nOnly the shared lists are here. The choices somebody typed into a single field belong to that field and are not listed.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "page": {
                                        "type": "integer",
                                        "default": 1,
                                        "description": "Which page to answer with."
                                    },
                                    "per_page": {
                                        "type": "integer",
                                        "default": 25,
                                        "description": "How many one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "A page of value lists, and how many there are in all. The lists of another account are never included.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The value lists on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One value list.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always value_list."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "integer",
                                                            "null"
                                                        ],
                                                        "description": "The id of the list, which is what value_list_id takes when a field is added or configured."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "What the list holds.",
                                                        "properties": {
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the list is called."
                                                            },
                                                            "items": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "The choices the list offers, in their order. An empty list when it offers none yet.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One choice.",
                                                                    "properties": {
                                                                        "id": {
                                                                            "type": [
                                                                                "integer",
                                                                                "null"
                                                                            ],
                                                                            "description": "The id of the choice, which is what a field offering this list stores as its value."
                                                                        },
                                                                        "label": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "What the choice says."
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "value_list",
                                            "id": 3,
                                            "attributes": {
                                                "name": "Genders",
                                                "items": [
                                                    {
                                                        "id": 11,
                                                        "label": "Woman"
                                                    },
                                                    {
                                                        "id": 12,
                                                        "label": "Man"
                                                    },
                                                    {
                                                        "id": 13,
                                                        "label": "Non-binary"
                                                    }
                                                ]
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/billing": {
            "get": {
                "operationId": "billing-show",
                "tags": [
                    "Billing"
                ],
                "summary": "Read what is being paid",
                "description": "Retrieve whether this account holds full access, how it holds it, what it is allowed against what it holds, the last payment, and the plans it may still take up.\n\nThere is no id in the URL: a token acts as one person, and one person has one account.\n\nNothing here is bought. Access moves only when Stripe confirms a payment, so a client that has just opened a checkout should read this again a moment later rather than assume anything.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "responses": {
                    "200": {
                        "description": "A billing object. On a self hosted instance every ceiling is null, the payment is null, offers is empty and access_kind is null, because nothing is sold there.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "What this account is paying, and what it is allowed.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always billing. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "has_full_access": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether every ceiling but storage is lifted, however the account came to hold that: bought once, subscribed, or opened by us."
                                                        },
                                                        "access_kind": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How full access is held: lifetime, subscription or granted, and null on the free plan. On a self hosted instance it is always null, because nothing is sold there."
                                                        },
                                                        "renews_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the subscription next bills, as a count of seconds since 1970. Null when nothing renews, which includes a subscription already on its way out."
                                                        },
                                                        "scheduled_offer": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The plan the subscription moves to at its next renewal, yearly after a move up, and null when no move is waiting. The move happens at renews_at, which is also when its price is first billed."
                                                        },
                                                        "ends_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When a cancelled subscription stops, as a count of seconds. Null while it renews, and until that moment the cancellation can still be taken back."
                                                        },
                                                        "purchased_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the one time purchase was ordered, as a count of seconds, null when it never was."
                                                        },
                                                        "order": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The one time purchase, null when nothing was ever ordered. A checkout nobody paid is not one, and an order that stopped holding stays here so that the end of access can be read.",
                                                            "properties": {
                                                                "provider_id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The checkout session at Stripe the order was placed through."
                                                                },
                                                                "status": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The state in Stripe's own words: paid while it holds full access, then refunded or disputed once money went back."
                                                                },
                                                                "offer": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "Which plan was bought, read from the price, null once Stripe no longer knows that price. A paid order holds full access whatever the answer."
                                                                },
                                                                "price_id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The price at Stripe the order was placed against, kept as it was at the sale."
                                                                },
                                                                "ordered_at": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "When the checkout was opened, as a count of seconds."
                                                                },
                                                                "settled_at": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "When Stripe called the payment paid, as a count of seconds, null once the order no longer holds."
                                                                }
                                                            }
                                                        },
                                                        "billing_email": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The address the invoices went to, null before anything was paid."
                                                        },
                                                        "limits": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "What the account is allowed. Null in any of these means no ceiling at all.",
                                                            "properties": {
                                                                "vaults": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "How many vaults may exist, null once full access is held."
                                                                },
                                                                "contacts": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "How many contacts may exist across every vault, null once full access is held. Each vault owner and anybody still marked partial is left out of the count."
                                                                },
                                                                "storage_in_bytes": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "How many bytes of files may be held. Full access lifts this to the paid figure rather than removing it, and null means the instance meters nothing."
                                                                }
                                                            }
                                                        },
                                                        "usage": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "What the account holds right now, measured the same way the ceilings are.",
                                                            "properties": {
                                                                "vaults": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "How many vaults exist."
                                                                },
                                                                "contacts": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "How many contacts the ceiling is measured against."
                                                                },
                                                                "storage_in_bytes": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "How many bytes of files are held."
                                                                }
                                                            }
                                                        },
                                                        "payment": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The most recent payment, null when nothing was ever paid, which is what an account we opened access on looks like.",
                                                            "properties": {
                                                                "provider_id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The id of the invoice at Stripe."
                                                                },
                                                                "offer": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "Which plan was paid for: monthly, yearly or lifetime. Read off the invoice rather than off the price it charged, and null when the catalogue no longer knows that price."
                                                                },
                                                                "status": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The state of the invoice, as Stripe names it."
                                                                },
                                                                "total": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "What was paid, in the smallest unit of the currency, tax included."
                                                                },
                                                                "currency": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The currency of that amount, three letters as Stripe writes them."
                                                                },
                                                                "invoice_number": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The number Stripe gave the invoice, null when it gave none."
                                                                },
                                                                "billed_at": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "When Stripe finalised the invoice, as a count of seconds."
                                                                }
                                                            }
                                                        },
                                                        "offers_available": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the catalogue could be read. False means Stripe did not answer and the list below is empty for that reason rather than because nothing is for sale."
                                                        },
                                                        "offers": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "What this account may still take up, shortest commitment first. Empty once it owns the product outright, and on a self hosted instance.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One plan.",
                                                                "properties": {
                                                                    "price_id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The id of the price at Stripe. It is what you send to open a checkout, and it is the only handle on a plan: prices, names and currencies all live at Stripe."
                                                                    },
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "monthly, yearly or lifetime. Every one of them unlocks exactly the same thing, so the kind says how often it bills and nothing else."
                                                                    },
                                                                    "renews": {
                                                                        "type": [
                                                                            "boolean",
                                                                            "null"
                                                                        ],
                                                                        "description": "Whether taking it up starts a subscription. False is the one time purchase."
                                                                    },
                                                                    "amount": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "The price in the smallest unit of the currency below."
                                                                    },
                                                                    "currency": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The currency Stripe quotes the plan in by default."
                                                                    },
                                                                    "prices": {
                                                                        "type": [
                                                                            "array",
                                                                            "null"
                                                                        ],
                                                                        "description": "Every currency this plan is quoted in, the default one included. Send one of them as currency when you open a checkout.",
                                                                        "items": {
                                                                            "type": [
                                                                                "object",
                                                                                "null"
                                                                            ],
                                                                            "description": "One amount in one currency.",
                                                                            "properties": {
                                                                                "currency": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Three letters as Stripe writes them."
                                                                                },
                                                                                "amount": {
                                                                                    "type": [
                                                                                        "integer",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "The price in the smallest unit of that currency."
                                                                                }
                                                                            }
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "billing",
                                        "attributes": {
                                            "has_full_access": true,
                                            "access_kind": "subscription",
                                            "renews_at": 1759752000,
                                            "scheduled_offer": null,
                                            "ends_at": null,
                                            "purchased_at": 1725710400,
                                            "order": {
                                                "provider_id": "cs_1QdundieScranton",
                                                "status": "refunded",
                                                "offer": "lifetime",
                                                "price_id": "price_1QdundieLifetime",
                                                "ordered_at": 1725710400,
                                                "settled_at": null
                                            },
                                            "billing_email": "michael.scott@dundermifflin.com",
                                            "limits": {
                                                "vaults": null,
                                                "contacts": null,
                                                "storage_in_bytes": 10737418240
                                            },
                                            "usage": {
                                                "vaults": 3,
                                                "contacts": 128,
                                                "storage_in_bytes": 5242880
                                            },
                                            "payment": {
                                                "provider_id": "in_1QdundieAwards",
                                                "offer": "monthly",
                                                "status": "paid",
                                                "total": 900,
                                                "currency": "eur",
                                                "invoice_number": "DM-0042",
                                                "billed_at": 1757073600
                                            },
                                            "offers_available": true,
                                            "offers": [
                                                {
                                                    "price_id": "price_1QdundieMonthly",
                                                    "kind": "monthly",
                                                    "renews": true,
                                                    "amount": 900,
                                                    "currency": "eur",
                                                    "prices": [
                                                        {
                                                            "currency": "eur",
                                                            "amount": 900
                                                        },
                                                        {
                                                            "currency": "usd",
                                                            "amount": 1000
                                                        }
                                                    ]
                                                }
                                            ]
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/billing"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "billing-show-query",
                "tags": [
                    "Billing"
                ],
                "summary": "Read what is being paid",
                "description": "Retrieve whether this account holds full access, how it holds it, what it is allowed against what it holds, the last payment, and the plans it may still take up.\n\nThere is no id in the URL: a token acts as one person, and one person has one account.\n\nNothing here is bought. Access moves only when Stripe confirms a payment, so a client that has just opened a checkout should read this again a moment later rather than assume anything.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "responses": {
                    "200": {
                        "description": "A billing object. On a self hosted instance every ceiling is null, the payment is null, offers is empty and access_kind is null, because nothing is sold there.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "What this account is paying, and what it is allowed.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always billing. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "has_full_access": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether every ceiling but storage is lifted, however the account came to hold that: bought once, subscribed, or opened by us."
                                                        },
                                                        "access_kind": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How full access is held: lifetime, subscription or granted, and null on the free plan. On a self hosted instance it is always null, because nothing is sold there."
                                                        },
                                                        "renews_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the subscription next bills, as a count of seconds since 1970. Null when nothing renews, which includes a subscription already on its way out."
                                                        },
                                                        "scheduled_offer": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The plan the subscription moves to at its next renewal, yearly after a move up, and null when no move is waiting. The move happens at renews_at, which is also when its price is first billed."
                                                        },
                                                        "ends_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When a cancelled subscription stops, as a count of seconds. Null while it renews, and until that moment the cancellation can still be taken back."
                                                        },
                                                        "purchased_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the one time purchase was ordered, as a count of seconds, null when it never was."
                                                        },
                                                        "order": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The one time purchase, null when nothing was ever ordered. A checkout nobody paid is not one, and an order that stopped holding stays here so that the end of access can be read.",
                                                            "properties": {
                                                                "provider_id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The checkout session at Stripe the order was placed through."
                                                                },
                                                                "status": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The state in Stripe's own words: paid while it holds full access, then refunded or disputed once money went back."
                                                                },
                                                                "offer": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "Which plan was bought, read from the price, null once Stripe no longer knows that price. A paid order holds full access whatever the answer."
                                                                },
                                                                "price_id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The price at Stripe the order was placed against, kept as it was at the sale."
                                                                },
                                                                "ordered_at": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "When the checkout was opened, as a count of seconds."
                                                                },
                                                                "settled_at": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "When Stripe called the payment paid, as a count of seconds, null once the order no longer holds."
                                                                }
                                                            }
                                                        },
                                                        "billing_email": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The address the invoices went to, null before anything was paid."
                                                        },
                                                        "limits": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "What the account is allowed. Null in any of these means no ceiling at all.",
                                                            "properties": {
                                                                "vaults": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "How many vaults may exist, null once full access is held."
                                                                },
                                                                "contacts": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "How many contacts may exist across every vault, null once full access is held. Each vault owner and anybody still marked partial is left out of the count."
                                                                },
                                                                "storage_in_bytes": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "How many bytes of files may be held. Full access lifts this to the paid figure rather than removing it, and null means the instance meters nothing."
                                                                }
                                                            }
                                                        },
                                                        "usage": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "What the account holds right now, measured the same way the ceilings are.",
                                                            "properties": {
                                                                "vaults": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "How many vaults exist."
                                                                },
                                                                "contacts": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "How many contacts the ceiling is measured against."
                                                                },
                                                                "storage_in_bytes": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "How many bytes of files are held."
                                                                }
                                                            }
                                                        },
                                                        "payment": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The most recent payment, null when nothing was ever paid, which is what an account we opened access on looks like.",
                                                            "properties": {
                                                                "provider_id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The id of the invoice at Stripe."
                                                                },
                                                                "offer": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "Which plan was paid for: monthly, yearly or lifetime. Read off the invoice rather than off the price it charged, and null when the catalogue no longer knows that price."
                                                                },
                                                                "status": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The state of the invoice, as Stripe names it."
                                                                },
                                                                "total": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "What was paid, in the smallest unit of the currency, tax included."
                                                                },
                                                                "currency": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The currency of that amount, three letters as Stripe writes them."
                                                                },
                                                                "invoice_number": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The number Stripe gave the invoice, null when it gave none."
                                                                },
                                                                "billed_at": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "When Stripe finalised the invoice, as a count of seconds."
                                                                }
                                                            }
                                                        },
                                                        "offers_available": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the catalogue could be read. False means Stripe did not answer and the list below is empty for that reason rather than because nothing is for sale."
                                                        },
                                                        "offers": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "What this account may still take up, shortest commitment first. Empty once it owns the product outright, and on a self hosted instance.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One plan.",
                                                                "properties": {
                                                                    "price_id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The id of the price at Stripe. It is what you send to open a checkout, and it is the only handle on a plan: prices, names and currencies all live at Stripe."
                                                                    },
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "monthly, yearly or lifetime. Every one of them unlocks exactly the same thing, so the kind says how often it bills and nothing else."
                                                                    },
                                                                    "renews": {
                                                                        "type": [
                                                                            "boolean",
                                                                            "null"
                                                                        ],
                                                                        "description": "Whether taking it up starts a subscription. False is the one time purchase."
                                                                    },
                                                                    "amount": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "The price in the smallest unit of the currency below."
                                                                    },
                                                                    "currency": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The currency Stripe quotes the plan in by default."
                                                                    },
                                                                    "prices": {
                                                                        "type": [
                                                                            "array",
                                                                            "null"
                                                                        ],
                                                                        "description": "Every currency this plan is quoted in, the default one included. Send one of them as currency when you open a checkout.",
                                                                        "items": {
                                                                            "type": [
                                                                                "object",
                                                                                "null"
                                                                            ],
                                                                            "description": "One amount in one currency.",
                                                                            "properties": {
                                                                                "currency": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Three letters as Stripe writes them."
                                                                                },
                                                                                "amount": {
                                                                                    "type": [
                                                                                        "integer",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "The price in the smallest unit of that currency."
                                                                                }
                                                                            }
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "billing",
                                        "attributes": {
                                            "has_full_access": true,
                                            "access_kind": "subscription",
                                            "renews_at": 1759752000,
                                            "scheduled_offer": null,
                                            "ends_at": null,
                                            "purchased_at": 1725710400,
                                            "order": {
                                                "provider_id": "cs_1QdundieScranton",
                                                "status": "refunded",
                                                "offer": "lifetime",
                                                "price_id": "price_1QdundieLifetime",
                                                "ordered_at": 1725710400,
                                                "settled_at": null
                                            },
                                            "billing_email": "michael.scott@dundermifflin.com",
                                            "limits": {
                                                "vaults": null,
                                                "contacts": null,
                                                "storage_in_bytes": 10737418240
                                            },
                                            "usage": {
                                                "vaults": 3,
                                                "contacts": 128,
                                                "storage_in_bytes": 5242880
                                            },
                                            "payment": {
                                                "provider_id": "in_1QdundieAwards",
                                                "offer": "monthly",
                                                "status": "paid",
                                                "total": 900,
                                                "currency": "eur",
                                                "invoice_number": "DM-0042",
                                                "billed_at": 1757073600
                                            },
                                            "offers_available": true,
                                            "offers": [
                                                {
                                                    "price_id": "price_1QdundieMonthly",
                                                    "kind": "monthly",
                                                    "renews": true,
                                                    "amount": 900,
                                                    "currency": "eur",
                                                    "prices": [
                                                        {
                                                            "currency": "eur",
                                                            "amount": 900
                                                        },
                                                        {
                                                            "currency": "usd",
                                                            "amount": 1000
                                                        }
                                                    ]
                                                }
                                            ]
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/billing"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/billing/payments": {
            "get": {
                "operationId": "billing-payments-index",
                "tags": [
                    "Billing"
                ],
                "summary": "List the payments",
                "description": "Retrieve every payment this account made, newest first, each with the invoice Stripe issued for it.\n\nOne row per invoice, whether it was the one time purchase or a renewal. They are kept here rather than read from Stripe on every call, so this never waits on Stripe and never stops working when Stripe does.\n\nAn account we opened access on has no payment at all, and so answers an empty list.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "How many payments one page holds. Brought into the allowed range rather than refused.",
                        "schema": {
                            "type": "integer",
                            "default": 25
                        },
                        "example": 50
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of payment objects, an empty list rather than an error when there are none.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The payments on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One payment.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always payment. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "provider_id": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The id of the invoice at Stripe, which is also this record's id. It is what makes a confirmation Stripe sends twice recognisable as one payment."
                                                            },
                                                            "offer": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Which plan was paid for: monthly, yearly or lifetime. It is kept as it stood on the day, so retagging a price at Stripe never rewrites the history, and it is null when the catalogue no longer knows the price that was charged."
                                                            },
                                                            "status": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The state of the invoice, as Stripe names it."
                                                            },
                                                            "total": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "What was paid, in the smallest unit of the currency, tax included."
                                                            },
                                                            "tax": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "The tax share of that total, worked out by Stripe from where the buyer was, and already part of it rather than added to it."
                                                            },
                                                            "currency": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The currency of both amounts, three letters as Stripe writes them."
                                                            },
                                                            "invoice_number": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The number Stripe gave the invoice, null when it gave none."
                                                            },
                                                            "invoice_url": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The page at Stripe where the invoice is read. Null when Stripe issued none."
                                                            },
                                                            "invoice_pdf_url": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The same invoice as a file. Null when Stripe issued none."
                                                            },
                                                            "billed_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When Stripe finalised the invoice, as a count of seconds since 1970. It is what the list is ordered by."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "payment",
                                            "id": "in_1QdundieAwards",
                                            "attributes": {
                                                "provider_id": "in_1QdundieAwards",
                                                "offer": "lifetime",
                                                "status": "paid",
                                                "total": 19900,
                                                "tax": 3317,
                                                "currency": "eur",
                                                "invoice_number": "DM-0042",
                                                "invoice_url": "https://invoice.stripe.com/i/test_a1dundermifflin",
                                                "invoice_pdf_url": "https://pay.stripe.com/invoice/test_a1dundermifflin/pdf",
                                                "billed_at": 1757073600
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/billing/payments/in_1QdundieAwards"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "billing-payments-index-query",
                "tags": [
                    "Billing"
                ],
                "summary": "List the payments",
                "description": "Retrieve every payment this account made, newest first, each with the invoice Stripe issued for it.\n\nOne row per invoice, whether it was the one time purchase or a renewal. They are kept here rather than read from Stripe on every call, so this never waits on Stripe and never stops working when Stripe does.\n\nAn account we opened access on has no payment at all, and so answers an empty list.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "per_page": {
                                        "type": "integer",
                                        "default": 25,
                                        "description": "How many payments one page holds. Brought into the allowed range rather than refused."
                                    }
                                }
                            },
                            "example": {
                                "per_page": 50
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "A page of payment objects, an empty list rather than an error when there are none.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The payments on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One payment.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always payment. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "provider_id": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The id of the invoice at Stripe, which is also this record's id. It is what makes a confirmation Stripe sends twice recognisable as one payment."
                                                            },
                                                            "offer": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Which plan was paid for: monthly, yearly or lifetime. It is kept as it stood on the day, so retagging a price at Stripe never rewrites the history, and it is null when the catalogue no longer knows the price that was charged."
                                                            },
                                                            "status": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The state of the invoice, as Stripe names it."
                                                            },
                                                            "total": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "What was paid, in the smallest unit of the currency, tax included."
                                                            },
                                                            "tax": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "The tax share of that total, worked out by Stripe from where the buyer was, and already part of it rather than added to it."
                                                            },
                                                            "currency": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The currency of both amounts, three letters as Stripe writes them."
                                                            },
                                                            "invoice_number": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The number Stripe gave the invoice, null when it gave none."
                                                            },
                                                            "invoice_url": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The page at Stripe where the invoice is read. Null when Stripe issued none."
                                                            },
                                                            "invoice_pdf_url": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The same invoice as a file. Null when Stripe issued none."
                                                            },
                                                            "billed_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When Stripe finalised the invoice, as a count of seconds since 1970. It is what the list is ordered by."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "payment",
                                            "id": "in_1QdundieAwards",
                                            "attributes": {
                                                "provider_id": "in_1QdundieAwards",
                                                "offer": "lifetime",
                                                "status": "paid",
                                                "total": 19900,
                                                "tax": 3317,
                                                "currency": "eur",
                                                "invoice_number": "DM-0042",
                                                "invoice_url": "https://invoice.stripe.com/i/test_a1dundermifflin",
                                                "invoice_pdf_url": "https://pay.stripe.com/invoice/test_a1dundermifflin/pdf",
                                                "billed_at": 1757073600
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/billing/payments/in_1QdundieAwards"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/billing/payments/{payment}": {
            "get": {
                "operationId": "billing-payments-show",
                "tags": [
                    "Billing"
                ],
                "summary": "Get one payment",
                "description": "Retrieve one payment by the id Stripe gave its invoice.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "payment",
                        "in": "path",
                        "required": true,
                        "description": "The id of the invoice at Stripe.",
                        "schema": {
                            "type": "string"
                        },
                        "example": "in_1QdundieAwards"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A payment object. Another account's payment answers 404, the same as one that does not exist.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The payment.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always payment. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "provider_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The id of the invoice at Stripe, which is also this record's id. It is what makes a confirmation Stripe sends twice recognisable as one payment."
                                                        },
                                                        "offer": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Which plan was paid for: monthly, yearly or lifetime. It is kept as it stood on the day, so retagging a price at Stripe never rewrites the history, and it is null when the catalogue no longer knows the price that was charged."
                                                        },
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The state of the invoice, as Stripe names it."
                                                        },
                                                        "total": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "What was paid, in the smallest unit of the currency, tax included."
                                                        },
                                                        "tax": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The tax share of that total, worked out by Stripe from where the buyer was, and already part of it rather than added to it."
                                                        },
                                                        "currency": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The currency of both amounts, three letters as Stripe writes them."
                                                        },
                                                        "invoice_number": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The number Stripe gave the invoice, null when it gave none."
                                                        },
                                                        "invoice_url": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The page at Stripe where the invoice is read. Null when Stripe issued none."
                                                        },
                                                        "invoice_pdf_url": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The same invoice as a file. Null when Stripe issued none."
                                                        },
                                                        "billed_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When Stripe finalised the invoice, as a count of seconds since 1970. It is what the list is ordered by."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "payment",
                                        "id": "in_1QdundieAwards",
                                        "attributes": {
                                            "provider_id": "in_1QdundieAwards",
                                            "offer": "lifetime",
                                            "status": "paid",
                                            "total": 19900,
                                            "tax": 3317,
                                            "currency": "eur",
                                            "invoice_number": "DM-0042",
                                            "invoice_url": "https://invoice.stripe.com/i/test_a1dundermifflin",
                                            "invoice_pdf_url": "https://pay.stripe.com/invoice/test_a1dundermifflin/pdf",
                                            "billed_at": 1757073600
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/billing/payments/in_1QdundieAwards"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "billing-payments-show-query",
                "tags": [
                    "Billing"
                ],
                "summary": "Get one payment",
                "description": "Retrieve one payment by the id Stripe gave its invoice.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "payment",
                        "in": "path",
                        "required": true,
                        "description": "The id of the invoice at Stripe.",
                        "schema": {
                            "type": "string"
                        },
                        "example": "in_1QdundieAwards"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A payment object. Another account's payment answers 404, the same as one that does not exist.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The payment.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always payment. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "provider_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The id of the invoice at Stripe, which is also this record's id. It is what makes a confirmation Stripe sends twice recognisable as one payment."
                                                        },
                                                        "offer": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Which plan was paid for: monthly, yearly or lifetime. It is kept as it stood on the day, so retagging a price at Stripe never rewrites the history, and it is null when the catalogue no longer knows the price that was charged."
                                                        },
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The state of the invoice, as Stripe names it."
                                                        },
                                                        "total": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "What was paid, in the smallest unit of the currency, tax included."
                                                        },
                                                        "tax": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The tax share of that total, worked out by Stripe from where the buyer was, and already part of it rather than added to it."
                                                        },
                                                        "currency": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The currency of both amounts, three letters as Stripe writes them."
                                                        },
                                                        "invoice_number": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The number Stripe gave the invoice, null when it gave none."
                                                        },
                                                        "invoice_url": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The page at Stripe where the invoice is read. Null when Stripe issued none."
                                                        },
                                                        "invoice_pdf_url": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The same invoice as a file. Null when Stripe issued none."
                                                        },
                                                        "billed_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When Stripe finalised the invoice, as a count of seconds since 1970. It is what the list is ordered by."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "payment",
                                        "id": "in_1QdundieAwards",
                                        "attributes": {
                                            "provider_id": "in_1QdundieAwards",
                                            "offer": "lifetime",
                                            "status": "paid",
                                            "total": 19900,
                                            "tax": 3317,
                                            "currency": "eur",
                                            "invoice_number": "DM-0042",
                                            "invoice_url": "https://invoice.stripe.com/i/test_a1dundermifflin",
                                            "invoice_pdf_url": "https://pay.stripe.com/invoice/test_a1dundermifflin/pdf",
                                            "billed_at": 1757073600
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/billing/payments/in_1QdundieAwards"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/billing/checkout-sessions": {
            "post": {
                "operationId": "billing-checkout-sessions-create",
                "tags": [
                    "Billing"
                ],
                "summary": "Open a checkout",
                "description": "Open a Stripe Checkout session for one of the plans and answer the page to send the buyer to.\n\nPayment is taken at Stripe and nowhere else: this API never receives card details. Access opens when Stripe confirms the payment, which is usually seconds after the buyer finishes, so read the billing object again rather than trusting their return.\n\nA price this account may not take up is refused before any session is opened. That covers an account that already owns the product outright, and a subscriber asking for a plan that does not sit above the one they are on.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "price_id": {
                                        "type": "string",
                                        "description": "The id of the price at Stripe, from offers in the billing object. Maximum 255 characters."
                                    },
                                    "currency": {
                                        "type": "string",
                                        "description": "Which of the currencies the plan is quoted in to charge, three letters. Left out, Stripe charges in the currency of the price."
                                    }
                                },
                                "required": [
                                    "price_id"
                                ]
                            },
                            "example": {
                                "price_id": "price_1QdundieMonthly",
                                "currency": "eur"
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "A checkout_session object carrying the URL. 422 when the price is not a plan this account may take up, and 503 when Stripe did not answer, in which case nothing was charged and nothing changed.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The checkout that was opened.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always checkout_session."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "url": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The page at Stripe to send the buyer to. It is short lived, it is the only place a card is ever entered, and opening it charges nothing on its own."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "checkout_session",
                                        "attributes": {
                                            "url": "https://checkout.stripe.com/c/pay/cs_test_a1dundermifflin"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/billing/subscription": {
            "put": {
                "operationId": "billing-subscription-update",
                "tags": [
                    "Billing"
                ],
                "summary": "Move the subscription up",
                "description": "Change the running subscription to a longer one, monthly to yearly, at its next renewal.\n\nNothing is charged on the day of the change and nothing changes until the renewal that was already planned. From that date, which does not move, the subscription is the longer one and bills its price. Until then the billing object carries the move in scheduled_offer.\n\nCancelling the subscription before that date drops the move, and taking the cancellation back does not bring it back.\n\nThere is one subscription throughout: no second one is opened, and access never gaps. Only a longer subscription is accepted, so a yearly subscriber cannot move back to monthly here, and lifetime access is bought through a checkout rather than swapped into.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "price_id": {
                                        "type": "string",
                                        "description": "The id of the price at Stripe to move to, from offers in the billing object. Maximum 255 characters."
                                    }
                                },
                                "required": [
                                    "price_id"
                                ]
                            },
                            "example": {
                                "price_id": "price_1QdundieYearly"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The billing object as it now stands, with scheduled_offer set. 422 when there is no subscription, when it is already ending, when a move is already waiting, or when the price is not a longer subscription.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "What this account is paying, and what it is allowed.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always billing. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "has_full_access": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether every ceiling but storage is lifted, however the account came to hold that: bought once, subscribed, or opened by us."
                                                        },
                                                        "access_kind": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How full access is held: lifetime, subscription or granted, and null on the free plan. On a self hosted instance it is always null, because nothing is sold there."
                                                        },
                                                        "renews_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the subscription next bills, as a count of seconds since 1970. Null when nothing renews, which includes a subscription already on its way out."
                                                        },
                                                        "scheduled_offer": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The plan the subscription moves to at its next renewal, yearly after a move up, and null when no move is waiting. The move happens at renews_at, which is also when its price is first billed."
                                                        },
                                                        "ends_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When a cancelled subscription stops, as a count of seconds. Null while it renews, and until that moment the cancellation can still be taken back."
                                                        },
                                                        "purchased_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the one time purchase was ordered, as a count of seconds, null when it never was."
                                                        },
                                                        "order": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The one time purchase, null when nothing was ever ordered. A checkout nobody paid is not one, and an order that stopped holding stays here so that the end of access can be read.",
                                                            "properties": {
                                                                "provider_id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The checkout session at Stripe the order was placed through."
                                                                },
                                                                "status": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The state in Stripe's own words: paid while it holds full access, then refunded or disputed once money went back."
                                                                },
                                                                "offer": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "Which plan was bought, read from the price, null once Stripe no longer knows that price. A paid order holds full access whatever the answer."
                                                                },
                                                                "price_id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The price at Stripe the order was placed against, kept as it was at the sale."
                                                                },
                                                                "ordered_at": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "When the checkout was opened, as a count of seconds."
                                                                },
                                                                "settled_at": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "When Stripe called the payment paid, as a count of seconds, null once the order no longer holds."
                                                                }
                                                            }
                                                        },
                                                        "billing_email": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The address the invoices went to, null before anything was paid."
                                                        },
                                                        "limits": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "What the account is allowed. Null in any of these means no ceiling at all.",
                                                            "properties": {
                                                                "vaults": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "How many vaults may exist, null once full access is held."
                                                                },
                                                                "contacts": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "How many contacts may exist across every vault, null once full access is held. Each vault owner and anybody still marked partial is left out of the count."
                                                                },
                                                                "storage_in_bytes": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "How many bytes of files may be held. Full access lifts this to the paid figure rather than removing it, and null means the instance meters nothing."
                                                                }
                                                            }
                                                        },
                                                        "usage": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "What the account holds right now, measured the same way the ceilings are.",
                                                            "properties": {
                                                                "vaults": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "How many vaults exist."
                                                                },
                                                                "contacts": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "How many contacts the ceiling is measured against."
                                                                },
                                                                "storage_in_bytes": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "How many bytes of files are held."
                                                                }
                                                            }
                                                        },
                                                        "payment": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The most recent payment, null when nothing was ever paid, which is what an account we opened access on looks like.",
                                                            "properties": {
                                                                "provider_id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The id of the invoice at Stripe."
                                                                },
                                                                "offer": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "Which plan was paid for: monthly, yearly or lifetime. Read off the invoice rather than off the price it charged, and null when the catalogue no longer knows that price."
                                                                },
                                                                "status": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The state of the invoice, as Stripe names it."
                                                                },
                                                                "total": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "What was paid, in the smallest unit of the currency, tax included."
                                                                },
                                                                "currency": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The currency of that amount, three letters as Stripe writes them."
                                                                },
                                                                "invoice_number": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The number Stripe gave the invoice, null when it gave none."
                                                                },
                                                                "billed_at": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "When Stripe finalised the invoice, as a count of seconds."
                                                                }
                                                            }
                                                        },
                                                        "offers_available": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the catalogue could be read. False means Stripe did not answer and the list below is empty for that reason rather than because nothing is for sale."
                                                        },
                                                        "offers": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "What this account may still take up, shortest commitment first. Empty once it owns the product outright, and on a self hosted instance.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One plan.",
                                                                "properties": {
                                                                    "price_id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The id of the price at Stripe. It is what you send to open a checkout, and it is the only handle on a plan: prices, names and currencies all live at Stripe."
                                                                    },
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "monthly, yearly or lifetime. Every one of them unlocks exactly the same thing, so the kind says how often it bills and nothing else."
                                                                    },
                                                                    "renews": {
                                                                        "type": [
                                                                            "boolean",
                                                                            "null"
                                                                        ],
                                                                        "description": "Whether taking it up starts a subscription. False is the one time purchase."
                                                                    },
                                                                    "amount": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "The price in the smallest unit of the currency below."
                                                                    },
                                                                    "currency": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The currency Stripe quotes the plan in by default."
                                                                    },
                                                                    "prices": {
                                                                        "type": [
                                                                            "array",
                                                                            "null"
                                                                        ],
                                                                        "description": "Every currency this plan is quoted in, the default one included. Send one of them as currency when you open a checkout.",
                                                                        "items": {
                                                                            "type": [
                                                                                "object",
                                                                                "null"
                                                                            ],
                                                                            "description": "One amount in one currency.",
                                                                            "properties": {
                                                                                "currency": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Three letters as Stripe writes them."
                                                                                },
                                                                                "amount": {
                                                                                    "type": [
                                                                                        "integer",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "The price in the smallest unit of that currency."
                                                                                }
                                                                            }
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "billing",
                                        "attributes": {
                                            "has_full_access": true,
                                            "access_kind": "subscription",
                                            "renews_at": 1759752000,
                                            "scheduled_offer": null,
                                            "ends_at": null,
                                            "purchased_at": 1725710400,
                                            "order": {
                                                "provider_id": "cs_1QdundieScranton",
                                                "status": "refunded",
                                                "offer": "lifetime",
                                                "price_id": "price_1QdundieLifetime",
                                                "ordered_at": 1725710400,
                                                "settled_at": null
                                            },
                                            "billing_email": "michael.scott@dundermifflin.com",
                                            "limits": {
                                                "vaults": null,
                                                "contacts": null,
                                                "storage_in_bytes": 10737418240
                                            },
                                            "usage": {
                                                "vaults": 3,
                                                "contacts": 128,
                                                "storage_in_bytes": 5242880
                                            },
                                            "payment": {
                                                "provider_id": "in_1QdundieAwards",
                                                "offer": "monthly",
                                                "status": "paid",
                                                "total": 900,
                                                "currency": "eur",
                                                "invoice_number": "DM-0042",
                                                "billed_at": 1757073600
                                            },
                                            "offers_available": true,
                                            "offers": [
                                                {
                                                    "price_id": "price_1QdundieMonthly",
                                                    "kind": "monthly",
                                                    "renews": true,
                                                    "amount": 900,
                                                    "currency": "eur",
                                                    "prices": [
                                                        {
                                                            "currency": "eur",
                                                            "amount": 900
                                                        },
                                                        {
                                                            "currency": "usd",
                                                            "amount": 1000
                                                        }
                                                    ]
                                                }
                                            ]
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/billing"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "delete": {
                "operationId": "billing-subscription-destroy",
                "tags": [
                    "Billing"
                ],
                "summary": "Cancel the subscription",
                "description": "Stop the subscription renewing at the end of the period already paid for.\n\nIt never takes effect at once. Full access stays to the last day that was paid for, the billing object then carries ends_at, and nothing the account holds is removed after that day: the free ceilings simply refuse additions again.\n\nUntil that day the cancellation can be taken back, at no charge, with the endpoint below.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "responses": {
                    "204": {
                        "description": "Nothing. 422 when there is no subscription to cancel, or when it is already ending."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/billing/subscription/cancellation": {
            "delete": {
                "operationId": "billing-subscription-cancellation-destroy",
                "tags": [
                    "Billing"
                ],
                "summary": "Take a cancellation back",
                "description": "Undo a cancellation that has not taken effect yet, so the same subscription goes on renewing.\n\nThe renewal date does not move and nothing is charged for changing your mind. It works only while the paid period is still running, which is exactly while the billing object carries ends_at.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "responses": {
                    "200": {
                        "description": "The billing object, with ends_at back to null. 422 when there is no subscription, or when it is not ending.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "What this account is paying, and what it is allowed.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always billing. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "has_full_access": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether every ceiling but storage is lifted, however the account came to hold that: bought once, subscribed, or opened by us."
                                                        },
                                                        "access_kind": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How full access is held: lifetime, subscription or granted, and null on the free plan. On a self hosted instance it is always null, because nothing is sold there."
                                                        },
                                                        "renews_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the subscription next bills, as a count of seconds since 1970. Null when nothing renews, which includes a subscription already on its way out."
                                                        },
                                                        "scheduled_offer": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The plan the subscription moves to at its next renewal, yearly after a move up, and null when no move is waiting. The move happens at renews_at, which is also when its price is first billed."
                                                        },
                                                        "ends_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When a cancelled subscription stops, as a count of seconds. Null while it renews, and until that moment the cancellation can still be taken back."
                                                        },
                                                        "purchased_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the one time purchase was ordered, as a count of seconds, null when it never was."
                                                        },
                                                        "order": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The one time purchase, null when nothing was ever ordered. A checkout nobody paid is not one, and an order that stopped holding stays here so that the end of access can be read.",
                                                            "properties": {
                                                                "provider_id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The checkout session at Stripe the order was placed through."
                                                                },
                                                                "status": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The state in Stripe's own words: paid while it holds full access, then refunded or disputed once money went back."
                                                                },
                                                                "offer": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "Which plan was bought, read from the price, null once Stripe no longer knows that price. A paid order holds full access whatever the answer."
                                                                },
                                                                "price_id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The price at Stripe the order was placed against, kept as it was at the sale."
                                                                },
                                                                "ordered_at": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "When the checkout was opened, as a count of seconds."
                                                                },
                                                                "settled_at": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "When Stripe called the payment paid, as a count of seconds, null once the order no longer holds."
                                                                }
                                                            }
                                                        },
                                                        "billing_email": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The address the invoices went to, null before anything was paid."
                                                        },
                                                        "limits": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "What the account is allowed. Null in any of these means no ceiling at all.",
                                                            "properties": {
                                                                "vaults": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "How many vaults may exist, null once full access is held."
                                                                },
                                                                "contacts": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "How many contacts may exist across every vault, null once full access is held. Each vault owner and anybody still marked partial is left out of the count."
                                                                },
                                                                "storage_in_bytes": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "How many bytes of files may be held. Full access lifts this to the paid figure rather than removing it, and null means the instance meters nothing."
                                                                }
                                                            }
                                                        },
                                                        "usage": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "What the account holds right now, measured the same way the ceilings are.",
                                                            "properties": {
                                                                "vaults": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "How many vaults exist."
                                                                },
                                                                "contacts": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "How many contacts the ceiling is measured against."
                                                                },
                                                                "storage_in_bytes": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "How many bytes of files are held."
                                                                }
                                                            }
                                                        },
                                                        "payment": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The most recent payment, null when nothing was ever paid, which is what an account we opened access on looks like.",
                                                            "properties": {
                                                                "provider_id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The id of the invoice at Stripe."
                                                                },
                                                                "offer": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "Which plan was paid for: monthly, yearly or lifetime. Read off the invoice rather than off the price it charged, and null when the catalogue no longer knows that price."
                                                                },
                                                                "status": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The state of the invoice, as Stripe names it."
                                                                },
                                                                "total": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "What was paid, in the smallest unit of the currency, tax included."
                                                                },
                                                                "currency": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The currency of that amount, three letters as Stripe writes them."
                                                                },
                                                                "invoice_number": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The number Stripe gave the invoice, null when it gave none."
                                                                },
                                                                "billed_at": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "When Stripe finalised the invoice, as a count of seconds."
                                                                }
                                                            }
                                                        },
                                                        "offers_available": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the catalogue could be read. False means Stripe did not answer and the list below is empty for that reason rather than because nothing is for sale."
                                                        },
                                                        "offers": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "What this account may still take up, shortest commitment first. Empty once it owns the product outright, and on a self hosted instance.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One plan.",
                                                                "properties": {
                                                                    "price_id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The id of the price at Stripe. It is what you send to open a checkout, and it is the only handle on a plan: prices, names and currencies all live at Stripe."
                                                                    },
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "monthly, yearly or lifetime. Every one of them unlocks exactly the same thing, so the kind says how often it bills and nothing else."
                                                                    },
                                                                    "renews": {
                                                                        "type": [
                                                                            "boolean",
                                                                            "null"
                                                                        ],
                                                                        "description": "Whether taking it up starts a subscription. False is the one time purchase."
                                                                    },
                                                                    "amount": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "The price in the smallest unit of the currency below."
                                                                    },
                                                                    "currency": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The currency Stripe quotes the plan in by default."
                                                                    },
                                                                    "prices": {
                                                                        "type": [
                                                                            "array",
                                                                            "null"
                                                                        ],
                                                                        "description": "Every currency this plan is quoted in, the default one included. Send one of them as currency when you open a checkout.",
                                                                        "items": {
                                                                            "type": [
                                                                                "object",
                                                                                "null"
                                                                            ],
                                                                            "description": "One amount in one currency.",
                                                                            "properties": {
                                                                                "currency": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Three letters as Stripe writes them."
                                                                                },
                                                                                "amount": {
                                                                                    "type": [
                                                                                        "integer",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "The price in the smallest unit of that currency."
                                                                                }
                                                                            }
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "billing",
                                        "attributes": {
                                            "has_full_access": true,
                                            "access_kind": "subscription",
                                            "renews_at": 1759752000,
                                            "scheduled_offer": null,
                                            "ends_at": null,
                                            "purchased_at": 1725710400,
                                            "order": {
                                                "provider_id": "cs_1QdundieScranton",
                                                "status": "refunded",
                                                "offer": "lifetime",
                                                "price_id": "price_1QdundieLifetime",
                                                "ordered_at": 1725710400,
                                                "settled_at": null
                                            },
                                            "billing_email": "michael.scott@dundermifflin.com",
                                            "limits": {
                                                "vaults": null,
                                                "contacts": null,
                                                "storage_in_bytes": 10737418240
                                            },
                                            "usage": {
                                                "vaults": 3,
                                                "contacts": 128,
                                                "storage_in_bytes": 5242880
                                            },
                                            "payment": {
                                                "provider_id": "in_1QdundieAwards",
                                                "offer": "monthly",
                                                "status": "paid",
                                                "total": 900,
                                                "currency": "eur",
                                                "invoice_number": "DM-0042",
                                                "billed_at": 1757073600
                                            },
                                            "offers_available": true,
                                            "offers": [
                                                {
                                                    "price_id": "price_1QdundieMonthly",
                                                    "kind": "monthly",
                                                    "renews": true,
                                                    "amount": 900,
                                                    "currency": "eur",
                                                    "prices": [
                                                        {
                                                            "currency": "eur",
                                                            "amount": 900
                                                        },
                                                        {
                                                            "currency": "usd",
                                                            "amount": 1000
                                                        }
                                                    ]
                                                }
                                            ]
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/billing"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/billing/portal-sessions": {
            "post": {
                "operationId": "billing-portal-sessions-create",
                "tags": [
                    "Billing"
                ],
                "summary": "Open the customer portal",
                "description": "Open Stripe's own customer portal and answer the page to send the owner to.\n\nThe portal is where invoices are read and the card on file is changed. Cancelling, resuming and moving up are turned off there on purpose, so that those decisions are made in one place, through this API or the product.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "responses": {
                    "201": {
                        "description": "A portal_session object carrying the URL. 422 when Stripe does not know the account yet, which is the case until something has been paid, and 503 when Stripe did not answer.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The portal session that was opened.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always portal_session."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "url": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The page at Stripe where the owner reads their invoices and changes the card on file. It is short lived, so open it rather than storing it."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "portal_session",
                                        "attributes": {
                                            "url": "https://billing.stripe.com/p/session/test_a1dundermifflin"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/duplicates": {
            "get": {
                "operationId": "duplicates-index",
                "tags": [
                    "Duplicates and merges"
                ],
                "summary": "List possible duplicates",
                "description": "List the pairs of contacts in one of your vaults that look like the same person, strongest resemblance first.\n\nTwo signals put a pair on this list. Names that resemble each other, and an exact shared value in a field your structure marks as identifying, which is what catches a pair whose names do not resemble each other at all. The reasons say which fired.\n\nThe list is worked out on a queue, not while you are reading it. Creating or renaming a contact queues a look at that contact, and a nightly pass looks at every vault, which is what notices a template that has just gained an identifying field. So a pair created a second ago may not be here yet.\n\nA pair somebody has ruled out is never in the list again. A vault with nothing doubled answers with an empty list rather than an error.\n\nNothing here merges anything. This says two records might be one person, and a person decides.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The id of the vault the contacts live in. A path that is not a uuid answers 404 without a query being run.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of pairs, and how many there are in all. A vault belonging to somebody else answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The pairs on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One pair.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always contact_duplicate_candidate. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "contact_id": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "One of the two contacts."
                                                            },
                                                            "other_contact_id": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The other one."
                                                            },
                                                            "contact_name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the first one is called, so a list reads without a second request."
                                                            },
                                                            "other_contact_name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the second one is called."
                                                            },
                                                            "score": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How strongly the two resemble each other, 0 to 100. It orders the list and says nothing about certainty."
                                                            },
                                                            "reasons": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "One entry per signal that fired.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One signal.",
                                                                    "properties": {
                                                                        "kind": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "Either name, when the two names resemble each other, or field, when the two share a value in a field the structure marks as identifying."
                                                                        },
                                                                        "field_key": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The key of that field. Only on a field signal."
                                                                        },
                                                                        "value": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The value the two share. Only on a field signal."
                                                                        }
                                                                    }
                                                                }
                                                            },
                                                            "dismissed_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When somebody said these are two different people, null while the pair stands."
                                                            },
                                                            "computed_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When detection last looked at this pair."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "contact_duplicate_candidate",
                                            "id": "42",
                                            "attributes": {
                                                "contact_id": "c4a1f7b2-8e36-4d59-b0a7-2f5c9d81e364",
                                                "other_contact_id": "7b2e9034-5c18-4af6-9d21-0e83b6c47a5f",
                                                "contact_name": "Jim Halpert",
                                                "other_contact_name": "Jimmy Halpert",
                                                "score": 95,
                                                "reasons": [
                                                    {
                                                        "kind": "field",
                                                        "field_key": "email",
                                                        "value": "jim@dundermifflin.com"
                                                    },
                                                    {
                                                        "kind": "name"
                                                    }
                                                ],
                                                "dismissed_at": null,
                                                "computed_at": 1757462400
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "duplicates-index-query",
                "tags": [
                    "Duplicates and merges"
                ],
                "summary": "List possible duplicates",
                "description": "List the pairs of contacts in one of your vaults that look like the same person, strongest resemblance first.\n\nTwo signals put a pair on this list. Names that resemble each other, and an exact shared value in a field your structure marks as identifying, which is what catches a pair whose names do not resemble each other at all. The reasons say which fired.\n\nThe list is worked out on a queue, not while you are reading it. Creating or renaming a contact queues a look at that contact, and a nightly pass looks at every vault, which is what notices a template that has just gained an identifying field. So a pair created a second ago may not be here yet.\n\nA pair somebody has ruled out is never in the list again. A vault with nothing doubled answers with an empty list rather than an error.\n\nNothing here merges anything. This says two records might be one person, and a person decides.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The id of the vault the contacts live in. A path that is not a uuid answers 404 without a query being run.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of pairs, and how many there are in all. A vault belonging to somebody else answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The pairs on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One pair.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always contact_duplicate_candidate. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "contact_id": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "One of the two contacts."
                                                            },
                                                            "other_contact_id": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The other one."
                                                            },
                                                            "contact_name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the first one is called, so a list reads without a second request."
                                                            },
                                                            "other_contact_name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the second one is called."
                                                            },
                                                            "score": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How strongly the two resemble each other, 0 to 100. It orders the list and says nothing about certainty."
                                                            },
                                                            "reasons": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "One entry per signal that fired.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One signal.",
                                                                    "properties": {
                                                                        "kind": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "Either name, when the two names resemble each other, or field, when the two share a value in a field the structure marks as identifying."
                                                                        },
                                                                        "field_key": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The key of that field. Only on a field signal."
                                                                        },
                                                                        "value": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The value the two share. Only on a field signal."
                                                                        }
                                                                    }
                                                                }
                                                            },
                                                            "dismissed_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When somebody said these are two different people, null while the pair stands."
                                                            },
                                                            "computed_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When detection last looked at this pair."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "contact_duplicate_candidate",
                                            "id": "42",
                                            "attributes": {
                                                "contact_id": "c4a1f7b2-8e36-4d59-b0a7-2f5c9d81e364",
                                                "other_contact_id": "7b2e9034-5c18-4af6-9d21-0e83b6c47a5f",
                                                "contact_name": "Jim Halpert",
                                                "other_contact_name": "Jimmy Halpert",
                                                "score": 95,
                                                "reasons": [
                                                    {
                                                        "kind": "field",
                                                        "field_key": "email",
                                                        "value": "jim@dundermifflin.com"
                                                    },
                                                    {
                                                        "kind": "name"
                                                    }
                                                ],
                                                "dismissed_at": null,
                                                "computed_at": 1757462400
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/duplicates/{candidate}/dismissal": {
            "put": {
                "operationId": "duplicates-dismissal-update",
                "tags": [
                    "Duplicates and merges"
                ],
                "summary": "Rule a pair out",
                "description": "Say that two contacts the product proposed are two different people.\n\nThis is permanent. Detection keeps recomputing and leaves the pair alone from now on, so it is never raised again even though the two still resemble each other, which they will.\n\nRuling out a pair that is already ruled out answers exactly the same way and changes nothing, so calling this twice is safe.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The id of the vault the contacts live in. A path that is not a uuid answers 404 without a query being run.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "candidate",
                        "in": "path",
                        "required": true,
                        "description": "The id of a pair this vault proposed.",
                        "schema": {
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The pair as it now reads, with dismissed_at set. A pair in another vault or another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The pair.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always contact_duplicate_candidate. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "contact_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of the two contacts."
                                                        },
                                                        "other_contact_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The other one."
                                                        },
                                                        "contact_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the first one is called, so a list reads without a second request."
                                                        },
                                                        "other_contact_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the second one is called."
                                                        },
                                                        "score": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How strongly the two resemble each other, 0 to 100. It orders the list and says nothing about certainty."
                                                        },
                                                        "reasons": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "One entry per signal that fired.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One signal.",
                                                                "properties": {
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Either name, when the two names resemble each other, or field, when the two share a value in a field the structure marks as identifying."
                                                                    },
                                                                    "field_key": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The key of that field. Only on a field signal."
                                                                    },
                                                                    "value": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The value the two share. Only on a field signal."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "dismissed_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When somebody said these are two different people, null while the pair stands."
                                                        },
                                                        "computed_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When detection last looked at this pair."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "contact_duplicate_candidate",
                                        "id": "42",
                                        "attributes": {
                                            "contact_id": "c4a1f7b2-8e36-4d59-b0a7-2f5c9d81e364",
                                            "other_contact_id": "7b2e9034-5c18-4af6-9d21-0e83b6c47a5f",
                                            "contact_name": "Jim Halpert",
                                            "other_contact_name": "Jimmy Halpert",
                                            "score": 95,
                                            "reasons": [
                                                {
                                                    "kind": "field",
                                                    "field_key": "email",
                                                    "value": "jim@dundermifflin.com"
                                                },
                                                {
                                                    "kind": "name"
                                                }
                                            ],
                                            "dismissed_at": 1757548800,
                                            "computed_at": 1757462400
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/contacts/{contact}/merge/{other}": {
            "get": {
                "operationId": "contacts-merge-show",
                "tags": [
                    "Duplicates and merges"
                ],
                "summary": "Preview a merge",
                "description": "Work out what merging one contact into another would do, without doing any of it.\n\nAsk this first. Whatever it reports is what the merge is then allowed to write: a decision it never asked about is refused, and a difference it did ask about and you left undecided is refused too.\n\nA difference is a place where both contacts hold a value and the two do not agree. A value only one of them holds is not a difference, it simply comes over.\n\nKeep the fingerprint. Hand it back when you merge, and if either contact changed in between the merge is refused rather than applied to a state nobody looked at.\n\nThe two contacts have to be in the same vault. Merging a contact with itself, and absorbing the contact that represents you, are both refused.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The id of the vault the contacts live in. A path that is not a uuid answers 404 without a query being run.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "contact",
                        "in": "path",
                        "required": true,
                        "description": "The contact that survives. Everything the other holds comes to it.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "other",
                        "in": "path",
                        "required": true,
                        "description": "The contact that is absorbed. It is kept, soft deleted, and its address lands on the survivor.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "What the merge would do. A contact belonging to somebody else, or reached through the wrong vault, answers 404. The same contact twice, or the contact representing you as the one absorbed, answers 422. While an import writes into the vault, or rolls back what it wrote, the preview answers 409.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The preview.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always contact_merge_preview."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the preview reports.",
                                                    "properties": {
                                                        "kept": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The surviving contact.",
                                                            "properties": {
                                                                "uuid": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "Its id."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What it is called."
                                                                }
                                                            }
                                                        },
                                                        "other": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The contact that would be absorbed.",
                                                            "properties": {
                                                                "uuid": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "Its id."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What it is called."
                                                                }
                                                            }
                                                        },
                                                        "conflicts": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "Every place the two disagree. Each one has to be decided before the merge will run.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One disagreement.",
                                                                "properties": {
                                                                    "field_key": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The key of the field, @avatar for the picture, or @display_name for the name shown. No field key starts with @. The name shown may be left undecided, and the surviving contact then keeps its own."
                                                                    },
                                                                    "field_id": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "The field, null for the picture and for the name shown."
                                                                    },
                                                                    "label": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field is called on the page."
                                                                    },
                                                                    "row": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "The repeater entry, null for a plain difference."
                                                                    },
                                                                    "kept_value": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the surviving contact holds."
                                                                    },
                                                                    "other_value": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the other one holds."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "moves": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "How much of each kind of thing would come over. A kind with nothing to move is left out.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One kind of thing.",
                                                                "properties": {
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "One of name_representation, field_value, field_value_row, reminder, share_link, group_membership or relation_pointer."
                                                                    },
                                                                    "count": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "How many of them."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "collisions": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "Repeater entries the merge would place identically twice. Each one has to be decided too. Empty when there are none."
                                                        },
                                                        "set_aside": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "Answers with no matching question on the surviving structure. They are kept out of the way rather than thrown away. Empty when there are none."
                                                        },
                                                        "folds": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "Groups both contacts are current members of. The two memberships become one, from the earlier join date, with the surviving contact's role unless it has none. Empty when there are none.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One group whose two memberships become one.",
                                                                "properties": {
                                                                    "group": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The id of the group."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the group is called."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "fingerprint": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the preview was built on. Hand it back when you merge and the merge is refused if either contact changed in between."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "contact_merge_preview",
                                        "attributes": {
                                            "kept": {
                                                "uuid": "c4a1f7b2-8e36-4d59-b0a7-2f5c9d81e364",
                                                "name": "Jim Halpert"
                                            },
                                            "other": {
                                                "uuid": "7b2e9034-5c18-4af6-9d21-0e83b6c47a5f",
                                                "name": "Jimmy Halpert"
                                            },
                                            "conflicts": [
                                                {
                                                    "field_key": "email",
                                                    "field_id": 12,
                                                    "label": "Email",
                                                    "row": null,
                                                    "kept_value": "jim@dundermifflin.com",
                                                    "other_value": "jimmy@dundermifflin.com"
                                                }
                                            ],
                                            "moves": [
                                                {
                                                    "kind": "field_value",
                                                    "count": 1
                                                }
                                            ],
                                            "collisions": [],
                                            "set_aside": [],
                                            "folds": [
                                                {
                                                    "group": "0199a2b4-7c1d-7e3f-9a40-5b6c7d8e9f01",
                                                    "name": "Halpert household"
                                                }
                                            ],
                                            "fingerprint": "5f2c9d1b7a34e806c5f19d2b48a7361ce0947fb52d8a1c6e3947b0d85f2a1c63"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "contacts-merge-show-query",
                "tags": [
                    "Duplicates and merges"
                ],
                "summary": "Preview a merge",
                "description": "Work out what merging one contact into another would do, without doing any of it.\n\nAsk this first. Whatever it reports is what the merge is then allowed to write: a decision it never asked about is refused, and a difference it did ask about and you left undecided is refused too.\n\nA difference is a place where both contacts hold a value and the two do not agree. A value only one of them holds is not a difference, it simply comes over.\n\nKeep the fingerprint. Hand it back when you merge, and if either contact changed in between the merge is refused rather than applied to a state nobody looked at.\n\nThe two contacts have to be in the same vault. Merging a contact with itself, and absorbing the contact that represents you, are both refused.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The id of the vault the contacts live in. A path that is not a uuid answers 404 without a query being run.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "contact",
                        "in": "path",
                        "required": true,
                        "description": "The contact that survives. Everything the other holds comes to it.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "other",
                        "in": "path",
                        "required": true,
                        "description": "The contact that is absorbed. It is kept, soft deleted, and its address lands on the survivor.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "What the merge would do. A contact belonging to somebody else, or reached through the wrong vault, answers 404. The same contact twice, or the contact representing you as the one absorbed, answers 422. While an import writes into the vault, or rolls back what it wrote, the preview answers 409.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The preview.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always contact_merge_preview."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the preview reports.",
                                                    "properties": {
                                                        "kept": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The surviving contact.",
                                                            "properties": {
                                                                "uuid": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "Its id."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What it is called."
                                                                }
                                                            }
                                                        },
                                                        "other": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The contact that would be absorbed.",
                                                            "properties": {
                                                                "uuid": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "Its id."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What it is called."
                                                                }
                                                            }
                                                        },
                                                        "conflicts": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "Every place the two disagree. Each one has to be decided before the merge will run.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One disagreement.",
                                                                "properties": {
                                                                    "field_key": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The key of the field, @avatar for the picture, or @display_name for the name shown. No field key starts with @. The name shown may be left undecided, and the surviving contact then keeps its own."
                                                                    },
                                                                    "field_id": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "The field, null for the picture and for the name shown."
                                                                    },
                                                                    "label": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field is called on the page."
                                                                    },
                                                                    "row": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "The repeater entry, null for a plain difference."
                                                                    },
                                                                    "kept_value": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the surviving contact holds."
                                                                    },
                                                                    "other_value": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the other one holds."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "moves": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "How much of each kind of thing would come over. A kind with nothing to move is left out.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One kind of thing.",
                                                                "properties": {
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "One of name_representation, field_value, field_value_row, reminder, share_link, group_membership or relation_pointer."
                                                                    },
                                                                    "count": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "How many of them."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "collisions": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "Repeater entries the merge would place identically twice. Each one has to be decided too. Empty when there are none."
                                                        },
                                                        "set_aside": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "Answers with no matching question on the surviving structure. They are kept out of the way rather than thrown away. Empty when there are none."
                                                        },
                                                        "folds": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "Groups both contacts are current members of. The two memberships become one, from the earlier join date, with the surviving contact's role unless it has none. Empty when there are none.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One group whose two memberships become one.",
                                                                "properties": {
                                                                    "group": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The id of the group."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the group is called."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "fingerprint": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the preview was built on. Hand it back when you merge and the merge is refused if either contact changed in between."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "contact_merge_preview",
                                        "attributes": {
                                            "kept": {
                                                "uuid": "c4a1f7b2-8e36-4d59-b0a7-2f5c9d81e364",
                                                "name": "Jim Halpert"
                                            },
                                            "other": {
                                                "uuid": "7b2e9034-5c18-4af6-9d21-0e83b6c47a5f",
                                                "name": "Jimmy Halpert"
                                            },
                                            "conflicts": [
                                                {
                                                    "field_key": "email",
                                                    "field_id": 12,
                                                    "label": "Email",
                                                    "row": null,
                                                    "kept_value": "jim@dundermifflin.com",
                                                    "other_value": "jimmy@dundermifflin.com"
                                                }
                                            ],
                                            "moves": [
                                                {
                                                    "kind": "field_value",
                                                    "count": 1
                                                }
                                            ],
                                            "collisions": [],
                                            "set_aside": [],
                                            "folds": [
                                                {
                                                    "group": "0199a2b4-7c1d-7e3f-9a40-5b6c7d8e9f01",
                                                    "name": "Halpert household"
                                                }
                                            ],
                                            "fingerprint": "5f2c9d1b7a34e806c5f19d2b48a7361ce0947fb52d8a1c6e3947b0d85f2a1c63"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "post": {
                "operationId": "contacts-merge-create",
                "tags": [
                    "Duplicates and merges"
                ],
                "summary": "Merge two contacts",
                "description": "Make two contacts one, keeping everything either of them held.\n\nEverything attached to the absorbed contact comes over: values, repeater entries, files, the picture, reminders, shared links, and the relation fields other records pointed at it through.\n\nNothing is destroyed. The absorbed contact is soft deleted and keeps its own rows, so a value you chose not to bring over is still there. A value the survivor gave up is set aside rather than deleted, and so is a value whose field the surviving structure does not carry.\n\nThe state of the survivor is captured before anything is written, and what moved is recorded, so the whole thing can be undone.\n\nSend one resolution for every difference and collision the preview reported, and none it did not. keep is kept or other for a difference, kept or both for a collision.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The id of the vault the contacts live in. A path that is not a uuid answers 404 without a query being run.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "contact",
                        "in": "path",
                        "required": true,
                        "description": "The contact that survives. Everything the other holds comes to it.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "other",
                        "in": "path",
                        "required": true,
                        "description": "The contact that is absorbed. It is kept, soft deleted, and its address lands on the survivor.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "fingerprint": {
                                        "type": "string",
                                        "description": "What the preview was built on. Leave it out and the merge runs against whatever the two contacts hold now, which is only safe if nothing else is writing."
                                    },
                                    "resolutions": {
                                        "type": "array",
                                        "description": "One entry per difference and collision the preview reported. Leave it out only when the preview reported none.",
                                        "items": {
                                            "type": "object",
                                            "properties": {
                                                "field_key": {
                                                    "type": "string",
                                                    "description": "The key of the field the preview named."
                                                },
                                                "row": {
                                                    "type": "integer",
                                                    "description": "The repeater entry, for a collision. Null or absent for a plain difference."
                                                },
                                                "keep": {
                                                    "type": "string",
                                                    "description": "kept or other for a difference. kept or both for a collision."
                                                }
                                            },
                                            "required": [
                                                "field_key",
                                                "keep"
                                            ]
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The record of the merge. A contact belonging to somebody else answers 404. A resolution the preview never reported, one left undecided, and absorbing the contact representing you each answer 422. A contact changed since the preview answers 409, and nothing is written. So does a merge asked for while an import writes into the vault or rolls back what it wrote.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The merge.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always contact_merge. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "kept_contact_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The contact that survived."
                                                        },
                                                        "merged_contact_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The contact that was absorbed. It is soft deleted, not destroyed."
                                                        },
                                                        "resolutions": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "What was decided at every difference, exactly as it was sent.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One decision.",
                                                                "properties": {
                                                                    "field_key": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The field it was about."
                                                                    },
                                                                    "row": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "The repeater entry, null for a plain difference."
                                                                    },
                                                                    "keep": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What was kept: kept, other or both."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "moved": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "What moved, row by row. It is what the undo replays backwards.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One thing that moved.",
                                                                "properties": {
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What happened, such as value_moved, row_moved, reminder_moved, value_detached or name_representation_moved."
                                                                    },
                                                                    "id": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "The row it happened to."
                                                                    },
                                                                    "from": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "The contact it came from, where the entry names one."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "For a way of writing the name that came over, where it stood in the list of the contact it came from."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "stands": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the merge is still in force. False once it has been undone."
                                                        },
                                                        "undone_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it was undone, null while it stands."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the merge ran."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "contact_merge",
                                        "id": "e58c3a17-90d2-4b6e-8f14-7a3c05d9b2e8",
                                        "attributes": {
                                            "kept_contact_id": "c4a1f7b2-8e36-4d59-b0a7-2f5c9d81e364",
                                            "merged_contact_id": "7b2e9034-5c18-4af6-9d21-0e83b6c47a5f",
                                            "resolutions": [
                                                {
                                                    "field_key": "email",
                                                    "row": null,
                                                    "keep": "kept"
                                                }
                                            ],
                                            "moved": [
                                                {
                                                    "kind": "name_representation_moved",
                                                    "id": 64,
                                                    "from": 27,
                                                    "position": 2
                                                },
                                                {
                                                    "kind": "value_moved",
                                                    "id": 811,
                                                    "from": 27
                                                }
                                            ],
                                            "stands": true,
                                            "undone_at": null,
                                            "created_at": 1757548800
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/merges/{merge}": {
            "delete": {
                "operationId": "merges-destroy",
                "tags": [
                    "Duplicates and merges"
                ],
                "summary": "Undo a merge",
                "description": "Put two merged contacts back the way they were.\n\nIt replays what the merge recorded, backwards, and brings the absorbed contact back. Everything that moved returns to the contact it came from, a value that was set aside is attached again, and a reminder the merge stopped starts again.\n\nEither the whole thing comes back or nothing does. An undo that cannot be completed is refused before anything is written, so a half-reversed merge is not a state you can reach.\n\nA merge stays undoable while the absorbed contact is retained, and nothing purges one today. A merge that has already been undone, and one whose absorbed contact is gone for good, are both refused.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The id of the vault the contacts live in. A path that is not a uuid answers 404 without a query being run.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "merge",
                        "in": "path",
                        "required": true,
                        "description": "The id of the merge to undo.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Nothing at all. A merge in another vault or another account answers 404. One already undone, or one whose absorbed contact is gone, answers 422 and nothing changes."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/notifications": {
            "get": {
                "operationId": "notifications-index",
                "tags": [
                    "Notifications"
                ],
                "summary": "List notifications",
                "description": "List what the application has told you, newest first.\n\nThese are yours rather than the account's: the list is scoped to whoever the token belongs to. One record is written per channel, so a reminder that went out both in the application and by email appears twice, once for each.\n\nNotifications are removed automatically once they pass the retention period this instance is set to. That is a stated policy rather than a silent loss, and what a reminder itself records outlives it: the deadline still says somebody was told.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "read",
                        "in": "query",
                        "required": false,
                        "description": "Narrow the list to what has been read, with true, or to what has not, with false. Anything else is ignored and the whole list comes back.",
                        "schema": {
                            "type": "string",
                            "default": "everything"
                        }
                    },
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to answer with.",
                        "schema": {
                            "type": "integer",
                            "default": 1
                        }
                    },
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "How many notifications one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused.",
                        "schema": {
                            "type": "integer",
                            "default": 25
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of notifications, and how many there are in all. An account that has never been told anything gets an empty list rather than an error.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The notifications on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One notification.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always notification. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "notification_type": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the notification is about, as a key such as reminder_due or digest. The set grows as the product finds new things to say, so match the keys you care about and let an unfamiliar one through rather than treating it as an error."
                                                            },
                                                            "channel": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Which way it went out: in_app, email, slack, telegram or sms. One notification is written per channel, so a reminder that went out two ways is two records here, alike in everything but this field."
                                                            },
                                                            "title": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The one line it leads with, up to 255 characters. For a reminder it is the name of the reminder."
                                                            },
                                                            "body": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What it says under the title, of no fixed length, written in the language the account was set to at the moment it was made rather than the one you are asking in."
                                                            },
                                                            "scheduled_for": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it was due, as a count of seconds since 1970. Quiet hours can hold a notification back, so this can be earlier than sent_at by hours."
                                                            },
                                                            "sent_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it went out, as a count of seconds since 1970, or null when it has not gone out yet."
                                                            },
                                                            "read_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it was first read, as a count of seconds since 1970, or null when it has not been. Reading something twice keeps the first moment."
                                                            },
                                                            "failure_reason": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the channel said when it refused, up to 255 characters, or null when nothing refused. A notification that failed keeps its record and its reason rather than disappearing."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the record was written, as a count of seconds since 1970."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "notification",
                                            "id": "9c7f2a1e-4b6d-4f0a-9f2b-1d3c5e7a9b11",
                                            "attributes": {
                                                "notification_type": "reminder_due",
                                                "channel": "in_app",
                                                "title": "Birthday, Michael Scott",
                                                "body": "It is in seven days.",
                                                "scheduled_for": 1756339200,
                                                "sent_at": 1756339210,
                                                "read_at": null,
                                                "failure_reason": null,
                                                "created_at": 1756339200
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/notifications/9c7f2a1e-4b6d-4f0a-9f2b-1d3c5e7a9b11"
                                            }
                                        },
                                        {
                                            "type": "notification",
                                            "id": "2f8e6c4a-7d1b-4e93-8a05-6c9f1b2d3e44",
                                            "attributes": {
                                                "notification_type": "reminder_due",
                                                "channel": "email",
                                                "title": "Anniversary, Jim Halpert",
                                                "body": "It is today.",
                                                "scheduled_for": 1756339200,
                                                "sent_at": 1756339210,
                                                "read_at": 1756342800,
                                                "failure_reason": null,
                                                "created_at": 1756339200
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/notifications/2f8e6c4a-7d1b-4e93-8a05-6c9f1b2d3e44"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 2
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "notifications-index-query",
                "tags": [
                    "Notifications"
                ],
                "summary": "List notifications",
                "description": "List what the application has told you, newest first.\n\nThese are yours rather than the account's: the list is scoped to whoever the token belongs to. One record is written per channel, so a reminder that went out both in the application and by email appears twice, once for each.\n\nNotifications are removed automatically once they pass the retention period this instance is set to. That is a stated policy rather than a silent loss, and what a reminder itself records outlives it: the deadline still says somebody was told.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "read": {
                                        "type": "string",
                                        "default": "everything",
                                        "description": "Narrow the list to what has been read, with true, or to what has not, with false. Anything else is ignored and the whole list comes back."
                                    },
                                    "page": {
                                        "type": "integer",
                                        "default": 1,
                                        "description": "Which page to answer with."
                                    },
                                    "per_page": {
                                        "type": "integer",
                                        "default": 25,
                                        "description": "How many notifications one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "A page of notifications, and how many there are in all. An account that has never been told anything gets an empty list rather than an error.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The notifications on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One notification.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always notification. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "notification_type": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the notification is about, as a key such as reminder_due or digest. The set grows as the product finds new things to say, so match the keys you care about and let an unfamiliar one through rather than treating it as an error."
                                                            },
                                                            "channel": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Which way it went out: in_app, email, slack, telegram or sms. One notification is written per channel, so a reminder that went out two ways is two records here, alike in everything but this field."
                                                            },
                                                            "title": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The one line it leads with, up to 255 characters. For a reminder it is the name of the reminder."
                                                            },
                                                            "body": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What it says under the title, of no fixed length, written in the language the account was set to at the moment it was made rather than the one you are asking in."
                                                            },
                                                            "scheduled_for": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it was due, as a count of seconds since 1970. Quiet hours can hold a notification back, so this can be earlier than sent_at by hours."
                                                            },
                                                            "sent_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it went out, as a count of seconds since 1970, or null when it has not gone out yet."
                                                            },
                                                            "read_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it was first read, as a count of seconds since 1970, or null when it has not been. Reading something twice keeps the first moment."
                                                            },
                                                            "failure_reason": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the channel said when it refused, up to 255 characters, or null when nothing refused. A notification that failed keeps its record and its reason rather than disappearing."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the record was written, as a count of seconds since 1970."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "notification",
                                            "id": "9c7f2a1e-4b6d-4f0a-9f2b-1d3c5e7a9b11",
                                            "attributes": {
                                                "notification_type": "reminder_due",
                                                "channel": "in_app",
                                                "title": "Birthday, Michael Scott",
                                                "body": "It is in seven days.",
                                                "scheduled_for": 1756339200,
                                                "sent_at": 1756339210,
                                                "read_at": null,
                                                "failure_reason": null,
                                                "created_at": 1756339200
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/notifications/9c7f2a1e-4b6d-4f0a-9f2b-1d3c5e7a9b11"
                                            }
                                        },
                                        {
                                            "type": "notification",
                                            "id": "2f8e6c4a-7d1b-4e93-8a05-6c9f1b2d3e44",
                                            "attributes": {
                                                "notification_type": "reminder_due",
                                                "channel": "email",
                                                "title": "Anniversary, Jim Halpert",
                                                "body": "It is today.",
                                                "scheduled_for": 1756339200,
                                                "sent_at": 1756339210,
                                                "read_at": 1756342800,
                                                "failure_reason": null,
                                                "created_at": 1756339200
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/notifications/2f8e6c4a-7d1b-4e93-8a05-6c9f1b2d3e44"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 2
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/notifications/{notification}": {
            "get": {
                "operationId": "notifications-show",
                "tags": [
                    "Notifications"
                ],
                "summary": "Get a notification",
                "description": "Retrieve one notification by its address.\n\nReading a notification through this endpoint does not mark it as read. Say so on purpose with the endpoint below, so that fetching a record and acting on it stay two separate things.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "notification",
                        "in": "path",
                        "required": true,
                        "description": "The address of the notification.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "One notification. A notification belonging to another account answers 404, and so does an address that matches nothing, deliberately: the two cannot be told apart.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The notification.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always notification. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "notification_type": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the notification is about, as a key such as reminder_due or digest. The set grows as the product finds new things to say, so match the keys you care about and let an unfamiliar one through rather than treating it as an error."
                                                        },
                                                        "channel": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Which way it went out: in_app, email, slack, telegram or sms. One notification is written per channel, so a reminder that went out two ways is two records here, alike in everything but this field."
                                                        },
                                                        "title": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The one line it leads with, up to 255 characters. For a reminder it is the name of the reminder."
                                                        },
                                                        "body": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What it says under the title, of no fixed length, written in the language the account was set to at the moment it was made rather than the one you are asking in."
                                                        },
                                                        "scheduled_for": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it was due, as a count of seconds since 1970. Quiet hours can hold a notification back, so this can be earlier than sent_at by hours."
                                                        },
                                                        "sent_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it went out, as a count of seconds since 1970, or null when it has not gone out yet."
                                                        },
                                                        "read_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it was first read, as a count of seconds since 1970, or null when it has not been. Reading something twice keeps the first moment."
                                                        },
                                                        "failure_reason": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the channel said when it refused, up to 255 characters, or null when nothing refused. A notification that failed keeps its record and its reason rather than disappearing."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the record was written, as a count of seconds since 1970."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "notification",
                                        "id": "9c7f2a1e-4b6d-4f0a-9f2b-1d3c5e7a9b11",
                                        "attributes": {
                                            "notification_type": "reminder_due",
                                            "channel": "in_app",
                                            "title": "Birthday, Michael Scott",
                                            "body": "It is in seven days.",
                                            "scheduled_for": 1756339200,
                                            "sent_at": 1756339210,
                                            "read_at": null,
                                            "failure_reason": null,
                                            "created_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/notifications/9c7f2a1e-4b6d-4f0a-9f2b-1d3c5e7a9b11"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "notifications-show-query",
                "tags": [
                    "Notifications"
                ],
                "summary": "Get a notification",
                "description": "Retrieve one notification by its address.\n\nReading a notification through this endpoint does not mark it as read. Say so on purpose with the endpoint below, so that fetching a record and acting on it stay two separate things.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "notification",
                        "in": "path",
                        "required": true,
                        "description": "The address of the notification.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "One notification. A notification belonging to another account answers 404, and so does an address that matches nothing, deliberately: the two cannot be told apart.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The notification.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always notification. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "notification_type": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the notification is about, as a key such as reminder_due or digest. The set grows as the product finds new things to say, so match the keys you care about and let an unfamiliar one through rather than treating it as an error."
                                                        },
                                                        "channel": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Which way it went out: in_app, email, slack, telegram or sms. One notification is written per channel, so a reminder that went out two ways is two records here, alike in everything but this field."
                                                        },
                                                        "title": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The one line it leads with, up to 255 characters. For a reminder it is the name of the reminder."
                                                        },
                                                        "body": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What it says under the title, of no fixed length, written in the language the account was set to at the moment it was made rather than the one you are asking in."
                                                        },
                                                        "scheduled_for": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it was due, as a count of seconds since 1970. Quiet hours can hold a notification back, so this can be earlier than sent_at by hours."
                                                        },
                                                        "sent_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it went out, as a count of seconds since 1970, or null when it has not gone out yet."
                                                        },
                                                        "read_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it was first read, as a count of seconds since 1970, or null when it has not been. Reading something twice keeps the first moment."
                                                        },
                                                        "failure_reason": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the channel said when it refused, up to 255 characters, or null when nothing refused. A notification that failed keeps its record and its reason rather than disappearing."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the record was written, as a count of seconds since 1970."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "notification",
                                        "id": "9c7f2a1e-4b6d-4f0a-9f2b-1d3c5e7a9b11",
                                        "attributes": {
                                            "notification_type": "reminder_due",
                                            "channel": "in_app",
                                            "title": "Birthday, Michael Scott",
                                            "body": "It is in seven days.",
                                            "scheduled_for": 1756339200,
                                            "sent_at": 1756339210,
                                            "read_at": null,
                                            "failure_reason": null,
                                            "created_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/notifications/9c7f2a1e-4b6d-4f0a-9f2b-1d3c5e7a9b11"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/notifications/{notification}/read": {
            "put": {
                "operationId": "notifications-read-update",
                "tags": [
                    "Notifications"
                ],
                "summary": "Mark a notification as read",
                "description": "Record that you have read one notification.\n\nMarking something read twice keeps the first moment, because that is when it was read. There is no way to mark one unread again: this records something that happened rather than setting a flag.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "notification",
                        "in": "path",
                        "required": true,
                        "description": "The address of the notification.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The notification as it now stands, carrying the moment it was read.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The notification.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always notification. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "notification_type": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the notification is about, as a key such as reminder_due or digest. The set grows as the product finds new things to say, so match the keys you care about and let an unfamiliar one through rather than treating it as an error."
                                                        },
                                                        "channel": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Which way it went out: in_app, email, slack, telegram or sms. One notification is written per channel, so a reminder that went out two ways is two records here, alike in everything but this field."
                                                        },
                                                        "title": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The one line it leads with, up to 255 characters. For a reminder it is the name of the reminder."
                                                        },
                                                        "body": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What it says under the title, of no fixed length, written in the language the account was set to at the moment it was made rather than the one you are asking in."
                                                        },
                                                        "scheduled_for": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it was due, as a count of seconds since 1970. Quiet hours can hold a notification back, so this can be earlier than sent_at by hours."
                                                        },
                                                        "sent_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it went out, as a count of seconds since 1970, or null when it has not gone out yet."
                                                        },
                                                        "read_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it was first read, as a count of seconds since 1970, or null when it has not been. Reading something twice keeps the first moment."
                                                        },
                                                        "failure_reason": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the channel said when it refused, up to 255 characters, or null when nothing refused. A notification that failed keeps its record and its reason rather than disappearing."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the record was written, as a count of seconds since 1970."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "notification",
                                        "id": "9c7f2a1e-4b6d-4f0a-9f2b-1d3c5e7a9b11",
                                        "attributes": {
                                            "notification_type": "reminder_due",
                                            "channel": "in_app",
                                            "title": "Birthday, Michael Scott",
                                            "body": "It is in seven days.",
                                            "scheduled_for": 1756339200,
                                            "sent_at": 1756339210,
                                            "read_at": 1756342800,
                                            "failure_reason": null,
                                            "created_at": 1756339200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/notifications/9c7f2a1e-4b6d-4f0a-9f2b-1d3c5e7a9b11"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/notifications/read": {
            "put": {
                "operationId": "notifications-read-all-update",
                "tags": [
                    "Notifications"
                ],
                "summary": "Mark every notification as read",
                "description": "Record that you have read everything waiting for you.\n\nEverything unread that belongs to you is marked at once. Nothing belonging to anybody else is touched, and nothing already read has its moment changed.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "responses": {
                    "200": {
                        "description": "How many notifications this marked. Nothing waiting answers with zero rather than an error.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "What this marked.",
                                            "properties": {
                                                "marked": {
                                                    "type": [
                                                        "integer",
                                                        "null"
                                                    ],
                                                    "description": "How many notifications went from unread to read. Zero when there was nothing waiting."
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "marked": 2
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/notification-channels": {
            "get": {
                "operationId": "notification-channels-index",
                "tags": [
                    "Notification channels"
                ],
                "summary": "List notification channels",
                "description": "List every way this account can be reached, and the state each one is in.\n\nEvery account has one record per channel from the moment it exists, so this list is never short and never has to be filled in first.\n\nNo channel asks the account for a credential. In app and email need none, and the provider account behind Telegram and the text message belongs to the instance, so all the account supplies is where to send.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "responses": {
                    "200": {
                        "description": "Every channel of the account, in the order the product names them.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "Every one of the channels, whole rather than a page at a time.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One channel.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always notification_channel. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "channel": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Which channel this is: in_app, email, telegram or sms. It also stands for the id of the record, so this is what goes in the path."
                                                            },
                                                            "label": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the channel is called, in the language you asked in."
                                                            },
                                                            "is_enabled": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the account wants anything to go out this way. A channel can be switched on only once everything below is satisfied."
                                                            },
                                                            "destination": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Where messages go: the room, the conversation or the number, up to 255 characters, or null when the channel asks for none or none has been given."
                                                            },
                                                            "needs_destination": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether this channel has to be told where to send. Email does not, because the address is already on you."
                                                            },
                                                            "discovers_destination": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the service hands us the destination rather than the account typing it. True for Telegram, where the account opens a conversation with the bot and the bot tells us which one it is. A destination sent for such a channel is refused."
                                                            },
                                                            "requires_proof": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the destination has to be proved before the channel may be switched on. True only for channels that accept a wrong destination without complaint, which today means text messages."
                                                            },
                                                            "is_proven": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether it has been proved. Always true for a channel with nothing to prove."
                                                            },
                                                            "is_configured_on_the_instance": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether this particular server has been set up to send on the channel. False only for a channel whose provider account belongs to the instance, which today means Telegram and the text message. Switching on a channel that is false here answers 422."
                                                            },
                                                            "disabled_reason": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Why the product switched the channel off itself, up to 255 characters, or null when it did not. Set when a channel refuses everything sent to it several times in a row."
                                                            },
                                                            "can_send_proof_code": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether a code may be sent to the destination right now. False on a channel with nothing to prove, inside the wait after a send, and once every code allowed has been sent."
                                                            },
                                                            "proof_code_refusal": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Why no code may be sent right now, in the words the settings screen prints, or null when one may."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "notification_channel",
                                            "id": "email",
                                            "attributes": {
                                                "channel": "email",
                                                "label": "Email",
                                                "is_enabled": true,
                                                "destination": null,
                                                "needs_destination": false,
                                                "discovers_destination": false,
                                                "requires_proof": false,
                                                "is_proven": true,
                                                "is_configured_on_the_instance": true,
                                                "disabled_reason": null,
                                                "can_send_proof_code": false,
                                                "proof_code_refusal": "This channel says for itself whether a destination is wrong, so it has nothing to prove."
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/notification-channels/email"
                                            }
                                        },
                                        {
                                            "type": "notification_channel",
                                            "id": "telegram",
                                            "attributes": {
                                                "channel": "telegram",
                                                "label": "Telegram",
                                                "is_enabled": true,
                                                "destination": "918273645",
                                                "needs_destination": true,
                                                "discovers_destination": true,
                                                "requires_proof": false,
                                                "is_proven": true,
                                                "is_configured_on_the_instance": true,
                                                "disabled_reason": null,
                                                "can_send_proof_code": false,
                                                "proof_code_refusal": "This channel says for itself whether a destination is wrong, so it has nothing to prove."
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/notification-channels/telegram"
                                            }
                                        },
                                        {
                                            "type": "notification_channel",
                                            "id": "sms",
                                            "attributes": {
                                                "channel": "sms",
                                                "label": "Text message",
                                                "is_enabled": false,
                                                "destination": "+15705550172",
                                                "needs_destination": true,
                                                "discovers_destination": false,
                                                "requires_proof": true,
                                                "is_proven": false,
                                                "is_configured_on_the_instance": true,
                                                "disabled_reason": null,
                                                "can_send_proof_code": true,
                                                "proof_code_refusal": null
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/notification-channels/sms"
                                            }
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "notification-channels-index-query",
                "tags": [
                    "Notification channels"
                ],
                "summary": "List notification channels",
                "description": "List every way this account can be reached, and the state each one is in.\n\nEvery account has one record per channel from the moment it exists, so this list is never short and never has to be filled in first.\n\nNo channel asks the account for a credential. In app and email need none, and the provider account behind Telegram and the text message belongs to the instance, so all the account supplies is where to send.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "responses": {
                    "200": {
                        "description": "Every channel of the account, in the order the product names them.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "Every one of the channels, whole rather than a page at a time.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One channel.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always notification_channel. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "channel": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Which channel this is: in_app, email, telegram or sms. It also stands for the id of the record, so this is what goes in the path."
                                                            },
                                                            "label": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the channel is called, in the language you asked in."
                                                            },
                                                            "is_enabled": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the account wants anything to go out this way. A channel can be switched on only once everything below is satisfied."
                                                            },
                                                            "destination": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Where messages go: the room, the conversation or the number, up to 255 characters, or null when the channel asks for none or none has been given."
                                                            },
                                                            "needs_destination": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether this channel has to be told where to send. Email does not, because the address is already on you."
                                                            },
                                                            "discovers_destination": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the service hands us the destination rather than the account typing it. True for Telegram, where the account opens a conversation with the bot and the bot tells us which one it is. A destination sent for such a channel is refused."
                                                            },
                                                            "requires_proof": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the destination has to be proved before the channel may be switched on. True only for channels that accept a wrong destination without complaint, which today means text messages."
                                                            },
                                                            "is_proven": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether it has been proved. Always true for a channel with nothing to prove."
                                                            },
                                                            "is_configured_on_the_instance": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether this particular server has been set up to send on the channel. False only for a channel whose provider account belongs to the instance, which today means Telegram and the text message. Switching on a channel that is false here answers 422."
                                                            },
                                                            "disabled_reason": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Why the product switched the channel off itself, up to 255 characters, or null when it did not. Set when a channel refuses everything sent to it several times in a row."
                                                            },
                                                            "can_send_proof_code": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether a code may be sent to the destination right now. False on a channel with nothing to prove, inside the wait after a send, and once every code allowed has been sent."
                                                            },
                                                            "proof_code_refusal": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Why no code may be sent right now, in the words the settings screen prints, or null when one may."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "notification_channel",
                                            "id": "email",
                                            "attributes": {
                                                "channel": "email",
                                                "label": "Email",
                                                "is_enabled": true,
                                                "destination": null,
                                                "needs_destination": false,
                                                "discovers_destination": false,
                                                "requires_proof": false,
                                                "is_proven": true,
                                                "is_configured_on_the_instance": true,
                                                "disabled_reason": null,
                                                "can_send_proof_code": false,
                                                "proof_code_refusal": "This channel says for itself whether a destination is wrong, so it has nothing to prove."
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/notification-channels/email"
                                            }
                                        },
                                        {
                                            "type": "notification_channel",
                                            "id": "telegram",
                                            "attributes": {
                                                "channel": "telegram",
                                                "label": "Telegram",
                                                "is_enabled": true,
                                                "destination": "918273645",
                                                "needs_destination": true,
                                                "discovers_destination": true,
                                                "requires_proof": false,
                                                "is_proven": true,
                                                "is_configured_on_the_instance": true,
                                                "disabled_reason": null,
                                                "can_send_proof_code": false,
                                                "proof_code_refusal": "This channel says for itself whether a destination is wrong, so it has nothing to prove."
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/notification-channels/telegram"
                                            }
                                        },
                                        {
                                            "type": "notification_channel",
                                            "id": "sms",
                                            "attributes": {
                                                "channel": "sms",
                                                "label": "Text message",
                                                "is_enabled": false,
                                                "destination": "+15705550172",
                                                "needs_destination": true,
                                                "discovers_destination": false,
                                                "requires_proof": true,
                                                "is_proven": false,
                                                "is_configured_on_the_instance": true,
                                                "disabled_reason": null,
                                                "can_send_proof_code": true,
                                                "proof_code_refusal": null
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/notification-channels/sms"
                                            }
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/notification-channels/{channel}": {
            "get": {
                "operationId": "notification-channels-show",
                "tags": [
                    "Notification channels"
                ],
                "summary": "Get a notification channel",
                "description": "Retrieve one channel and what it still needs.\n\nRead needs_destination and requires_proof against destination and is_proven to work out what is left to do before is_enabled can be set.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "channel",
                        "in": "path",
                        "required": true,
                        "description": "Which channel: in_app, email, telegram or sms. Anything else answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "One channel. A channel name the product does not know answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The channel.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always notification_channel. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "channel": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Which channel this is: in_app, email, telegram or sms. It also stands for the id of the record, so this is what goes in the path."
                                                        },
                                                        "label": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the channel is called, in the language you asked in."
                                                        },
                                                        "is_enabled": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the account wants anything to go out this way. A channel can be switched on only once everything below is satisfied."
                                                        },
                                                        "destination": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where messages go: the room, the conversation or the number, up to 255 characters, or null when the channel asks for none or none has been given."
                                                        },
                                                        "needs_destination": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether this channel has to be told where to send. Email does not, because the address is already on you."
                                                        },
                                                        "discovers_destination": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the service hands us the destination rather than the account typing it. True for Telegram, where the account opens a conversation with the bot and the bot tells us which one it is. A destination sent for such a channel is refused."
                                                        },
                                                        "requires_proof": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the destination has to be proved before the channel may be switched on. True only for channels that accept a wrong destination without complaint, which today means text messages."
                                                        },
                                                        "is_proven": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether it has been proved. Always true for a channel with nothing to prove."
                                                        },
                                                        "is_configured_on_the_instance": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether this particular server has been set up to send on the channel. False only for a channel whose provider account belongs to the instance, which today means Telegram and the text message. Switching on a channel that is false here answers 422."
                                                        },
                                                        "disabled_reason": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Why the product switched the channel off itself, up to 255 characters, or null when it did not. Set when a channel refuses everything sent to it several times in a row."
                                                        },
                                                        "can_send_proof_code": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether a code may be sent to the destination right now. False on a channel with nothing to prove, inside the wait after a send, and once every code allowed has been sent."
                                                        },
                                                        "proof_code_refusal": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Why no code may be sent right now, in the words the settings screen prints, or null when one may."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "notification_channel",
                                        "id": "telegram",
                                        "attributes": {
                                            "channel": "telegram",
                                            "label": "Telegram",
                                            "is_enabled": true,
                                            "destination": "918273645",
                                            "needs_destination": true,
                                            "discovers_destination": true,
                                            "requires_proof": false,
                                            "is_proven": true,
                                            "is_configured_on_the_instance": true,
                                            "disabled_reason": null,
                                            "can_send_proof_code": false,
                                            "proof_code_refusal": "This channel says for itself whether a destination is wrong, so it has nothing to prove."
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/notification-channels/telegram"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "notification-channels-show-query",
                "tags": [
                    "Notification channels"
                ],
                "summary": "Get a notification channel",
                "description": "Retrieve one channel and what it still needs.\n\nRead needs_destination and requires_proof against destination and is_proven to work out what is left to do before is_enabled can be set.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "channel",
                        "in": "path",
                        "required": true,
                        "description": "Which channel: in_app, email, telegram or sms. Anything else answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "One channel. A channel name the product does not know answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The channel.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always notification_channel. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "channel": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Which channel this is: in_app, email, telegram or sms. It also stands for the id of the record, so this is what goes in the path."
                                                        },
                                                        "label": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the channel is called, in the language you asked in."
                                                        },
                                                        "is_enabled": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the account wants anything to go out this way. A channel can be switched on only once everything below is satisfied."
                                                        },
                                                        "destination": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where messages go: the room, the conversation or the number, up to 255 characters, or null when the channel asks for none or none has been given."
                                                        },
                                                        "needs_destination": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether this channel has to be told where to send. Email does not, because the address is already on you."
                                                        },
                                                        "discovers_destination": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the service hands us the destination rather than the account typing it. True for Telegram, where the account opens a conversation with the bot and the bot tells us which one it is. A destination sent for such a channel is refused."
                                                        },
                                                        "requires_proof": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the destination has to be proved before the channel may be switched on. True only for channels that accept a wrong destination without complaint, which today means text messages."
                                                        },
                                                        "is_proven": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether it has been proved. Always true for a channel with nothing to prove."
                                                        },
                                                        "is_configured_on_the_instance": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether this particular server has been set up to send on the channel. False only for a channel whose provider account belongs to the instance, which today means Telegram and the text message. Switching on a channel that is false here answers 422."
                                                        },
                                                        "disabled_reason": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Why the product switched the channel off itself, up to 255 characters, or null when it did not. Set when a channel refuses everything sent to it several times in a row."
                                                        },
                                                        "can_send_proof_code": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether a code may be sent to the destination right now. False on a channel with nothing to prove, inside the wait after a send, and once every code allowed has been sent."
                                                        },
                                                        "proof_code_refusal": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Why no code may be sent right now, in the words the settings screen prints, or null when one may."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "notification_channel",
                                        "id": "telegram",
                                        "attributes": {
                                            "channel": "telegram",
                                            "label": "Telegram",
                                            "is_enabled": true,
                                            "destination": "918273645",
                                            "needs_destination": true,
                                            "discovers_destination": true,
                                            "requires_proof": false,
                                            "is_proven": true,
                                            "is_configured_on_the_instance": true,
                                            "disabled_reason": null,
                                            "can_send_proof_code": false,
                                            "proof_code_refusal": "This channel says for itself whether a destination is wrong, so it has nothing to prove."
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/notification-channels/telegram"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "put": {
                "operationId": "notification-channels-update",
                "tags": [
                    "Notification channels"
                ],
                "summary": "Change a notification channel",
                "description": "Set where a channel sends, what it signs in with, and whether it is on.\n\nSwitching a channel on is refused with 422 while anything it asks for is missing, and the message says which. A channel that has to be proved is refused until it has been.\n\nChanging destination throws away the proof, because the proof was about the old destination and says nothing about the new one.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "channel",
                        "in": "path",
                        "required": true,
                        "description": "Which channel: in_app, email, telegram or sms. Anything else answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "is_enabled": {
                                        "type": "boolean",
                                        "description": "Whether anything should go out this way. False is always allowed, whatever state the channel is in. It cannot be null."
                                    },
                                    "destination": {
                                        "type": "string",
                                        "description": "Where to send: the room, the conversation or the number, up to 255 characters. Unlike other fields, null keeps whatever is saved rather than clearing it."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The channel as it now stands.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The channel.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always notification_channel. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "channel": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Which channel this is: in_app, email, telegram or sms. It also stands for the id of the record, so this is what goes in the path."
                                                        },
                                                        "label": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the channel is called, in the language you asked in."
                                                        },
                                                        "is_enabled": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the account wants anything to go out this way. A channel can be switched on only once everything below is satisfied."
                                                        },
                                                        "destination": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where messages go: the room, the conversation or the number, up to 255 characters, or null when the channel asks for none or none has been given."
                                                        },
                                                        "needs_destination": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether this channel has to be told where to send. Email does not, because the address is already on you."
                                                        },
                                                        "discovers_destination": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the service hands us the destination rather than the account typing it. True for Telegram, where the account opens a conversation with the bot and the bot tells us which one it is. A destination sent for such a channel is refused."
                                                        },
                                                        "requires_proof": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the destination has to be proved before the channel may be switched on. True only for channels that accept a wrong destination without complaint, which today means text messages."
                                                        },
                                                        "is_proven": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether it has been proved. Always true for a channel with nothing to prove."
                                                        },
                                                        "is_configured_on_the_instance": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether this particular server has been set up to send on the channel. False only for a channel whose provider account belongs to the instance, which today means Telegram and the text message. Switching on a channel that is false here answers 422."
                                                        },
                                                        "disabled_reason": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Why the product switched the channel off itself, up to 255 characters, or null when it did not. Set when a channel refuses everything sent to it several times in a row."
                                                        },
                                                        "can_send_proof_code": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether a code may be sent to the destination right now. False on a channel with nothing to prove, inside the wait after a send, and once every code allowed has been sent."
                                                        },
                                                        "proof_code_refusal": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Why no code may be sent right now, in the words the settings screen prints, or null when one may."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "notification_channel",
                                        "id": "telegram",
                                        "attributes": {
                                            "channel": "telegram",
                                            "label": "Telegram",
                                            "is_enabled": true,
                                            "destination": "918273645",
                                            "needs_destination": true,
                                            "discovers_destination": true,
                                            "requires_proof": false,
                                            "is_proven": true,
                                            "is_configured_on_the_instance": true,
                                            "disabled_reason": null,
                                            "can_send_proof_code": false,
                                            "proof_code_refusal": "This channel says for itself whether a destination is wrong, so it has nothing to prove."
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/notification-channels/telegram"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/notification-channels/{channel}/setup": {
            "delete": {
                "operationId": "notification-channels-setup-destroy",
                "tags": [
                    "Notification channels"
                ],
                "summary": "Remove the setup of a notification channel",
                "description": "Erase what the account gave a channel, its number or its Telegram conversation, and switch the channel off.\n\nThe channel itself stays, so it is still listed and can be set up again from the start. A code waiting to be typed back and a Telegram connection not yet finished stop working, and nothing more is sent to the erased destination, including notifications already waiting.\n\nIn app and email hold nothing to remove and answer 422. A channel nobody has set up is returned unchanged. A number kept while text messages are withdrawn from the account can still be removed here, the one request that reaches that channel.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "channel",
                        "in": "path",
                        "required": true,
                        "description": "Which channel: in_app, email, telegram or sms. Anything else answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The channel as it now stands, with destination null and is_enabled false.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The channel.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always notification_channel. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "channel": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Which channel this is: in_app, email, telegram or sms. It also stands for the id of the record, so this is what goes in the path."
                                                        },
                                                        "label": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the channel is called, in the language you asked in."
                                                        },
                                                        "is_enabled": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the account wants anything to go out this way. A channel can be switched on only once everything below is satisfied."
                                                        },
                                                        "destination": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where messages go: the room, the conversation or the number, up to 255 characters, or null when the channel asks for none or none has been given."
                                                        },
                                                        "needs_destination": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether this channel has to be told where to send. Email does not, because the address is already on you."
                                                        },
                                                        "discovers_destination": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the service hands us the destination rather than the account typing it. True for Telegram, where the account opens a conversation with the bot and the bot tells us which one it is. A destination sent for such a channel is refused."
                                                        },
                                                        "requires_proof": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the destination has to be proved before the channel may be switched on. True only for channels that accept a wrong destination without complaint, which today means text messages."
                                                        },
                                                        "is_proven": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether it has been proved. Always true for a channel with nothing to prove."
                                                        },
                                                        "is_configured_on_the_instance": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether this particular server has been set up to send on the channel. False only for a channel whose provider account belongs to the instance, which today means Telegram and the text message. Switching on a channel that is false here answers 422."
                                                        },
                                                        "disabled_reason": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Why the product switched the channel off itself, up to 255 characters, or null when it did not. Set when a channel refuses everything sent to it several times in a row."
                                                        },
                                                        "can_send_proof_code": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether a code may be sent to the destination right now. False on a channel with nothing to prove, inside the wait after a send, and once every code allowed has been sent."
                                                        },
                                                        "proof_code_refusal": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Why no code may be sent right now, in the words the settings screen prints, or null when one may."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "notification_channel",
                                        "id": "sms",
                                        "attributes": {
                                            "channel": "sms",
                                            "label": "Text message",
                                            "is_enabled": false,
                                            "destination": null,
                                            "needs_destination": true,
                                            "discovers_destination": false,
                                            "requires_proof": true,
                                            "is_proven": false,
                                            "is_configured_on_the_instance": true,
                                            "disabled_reason": null,
                                            "can_send_proof_code": true,
                                            "proof_code_refusal": null
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/notification-channels/sms"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/notification-channels/{channel}/proof": {
            "post": {
                "operationId": "notification-channels-proof-store",
                "tags": [
                    "Notification channels"
                ],
                "summary": "Send a code to a destination",
                "description": "Send a code to a destination to find out whether it is really yours.\n\nOnly a channel whose requires_proof is true accepts this. A text message provider takes any well formed number, so a send that appears to have worked proves nothing; a code that comes back proves somebody holding that number typed it.\n\nCall it again for another code to the same destination. The new code replaces the previous one, which stops being accepted, and starts with its full lifetime and its full set of tries.\n\nTwo sends are at least the wait set by this instance apart (one minute unless it says otherwise), and only so many codes may be sent before the destination has to be removed and typed again. A request inside the wait, including one racing another, or past the limit, answers 422 on channel with the reason that proof_code_refusal gives.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "channel",
                        "in": "path",
                        "required": true,
                        "description": "Which channel: in_app, email, telegram or sms. Anything else answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "201": {
                        "description": "The channel, still unproven. The code itself is never returned: it goes to the destination and nowhere else.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The channel.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always notification_channel. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "channel": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Which channel this is: in_app, email, telegram or sms. It also stands for the id of the record, so this is what goes in the path."
                                                        },
                                                        "label": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the channel is called, in the language you asked in."
                                                        },
                                                        "is_enabled": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the account wants anything to go out this way. A channel can be switched on only once everything below is satisfied."
                                                        },
                                                        "destination": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where messages go: the room, the conversation or the number, up to 255 characters, or null when the channel asks for none or none has been given."
                                                        },
                                                        "needs_destination": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether this channel has to be told where to send. Email does not, because the address is already on you."
                                                        },
                                                        "discovers_destination": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the service hands us the destination rather than the account typing it. True for Telegram, where the account opens a conversation with the bot and the bot tells us which one it is. A destination sent for such a channel is refused."
                                                        },
                                                        "requires_proof": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the destination has to be proved before the channel may be switched on. True only for channels that accept a wrong destination without complaint, which today means text messages."
                                                        },
                                                        "is_proven": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether it has been proved. Always true for a channel with nothing to prove."
                                                        },
                                                        "is_configured_on_the_instance": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether this particular server has been set up to send on the channel. False only for a channel whose provider account belongs to the instance, which today means Telegram and the text message. Switching on a channel that is false here answers 422."
                                                        },
                                                        "disabled_reason": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Why the product switched the channel off itself, up to 255 characters, or null when it did not. Set when a channel refuses everything sent to it several times in a row."
                                                        },
                                                        "can_send_proof_code": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether a code may be sent to the destination right now. False on a channel with nothing to prove, inside the wait after a send, and once every code allowed has been sent."
                                                        },
                                                        "proof_code_refusal": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Why no code may be sent right now, in the words the settings screen prints, or null when one may."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "notification_channel",
                                        "id": "sms",
                                        "attributes": {
                                            "channel": "sms",
                                            "label": "Text message",
                                            "is_enabled": false,
                                            "destination": "+15705550172",
                                            "needs_destination": true,
                                            "discovers_destination": false,
                                            "requires_proof": true,
                                            "is_proven": false,
                                            "is_configured_on_the_instance": true,
                                            "disabled_reason": null,
                                            "can_send_proof_code": true,
                                            "proof_code_refusal": null
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/notification-channels/sms"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "put": {
                "operationId": "notification-channels-proof-update",
                "tags": [
                    "Notification channels"
                ],
                "summary": "Confirm a code",
                "description": "Type the code back to prove the destination is yours.\n\nThe three ways this can fail are said separately, because wrong, too late and too many tries ask three different things of whoever is reading. Each answers 422 with its own message.\n\nWrong guesses are counted, and past the limit the code is spent whether or not the next guess would have been right. Ask for another one.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "channel",
                        "in": "path",
                        "required": true,
                        "description": "Which channel: in_app, email, telegram or sms. Anything else answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "code": {
                                        "type": "string",
                                        "description": "The code that was sent to the destination, up to 16 characters."
                                    }
                                },
                                "required": [
                                    "code"
                                ]
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The channel with is_proven true. It still has to be switched on separately.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The channel.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always notification_channel. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "channel": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Which channel this is: in_app, email, telegram or sms. It also stands for the id of the record, so this is what goes in the path."
                                                        },
                                                        "label": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the channel is called, in the language you asked in."
                                                        },
                                                        "is_enabled": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the account wants anything to go out this way. A channel can be switched on only once everything below is satisfied."
                                                        },
                                                        "destination": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where messages go: the room, the conversation or the number, up to 255 characters, or null when the channel asks for none or none has been given."
                                                        },
                                                        "needs_destination": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether this channel has to be told where to send. Email does not, because the address is already on you."
                                                        },
                                                        "discovers_destination": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the service hands us the destination rather than the account typing it. True for Telegram, where the account opens a conversation with the bot and the bot tells us which one it is. A destination sent for such a channel is refused."
                                                        },
                                                        "requires_proof": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the destination has to be proved before the channel may be switched on. True only for channels that accept a wrong destination without complaint, which today means text messages."
                                                        },
                                                        "is_proven": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether it has been proved. Always true for a channel with nothing to prove."
                                                        },
                                                        "is_configured_on_the_instance": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether this particular server has been set up to send on the channel. False only for a channel whose provider account belongs to the instance, which today means Telegram and the text message. Switching on a channel that is false here answers 422."
                                                        },
                                                        "disabled_reason": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Why the product switched the channel off itself, up to 255 characters, or null when it did not. Set when a channel refuses everything sent to it several times in a row."
                                                        },
                                                        "can_send_proof_code": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether a code may be sent to the destination right now. False on a channel with nothing to prove, inside the wait after a send, and once every code allowed has been sent."
                                                        },
                                                        "proof_code_refusal": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Why no code may be sent right now, in the words the settings screen prints, or null when one may."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "notification_channel",
                                        "id": "sms",
                                        "attributes": {
                                            "channel": "sms",
                                            "label": "Text message",
                                            "is_enabled": false,
                                            "destination": "+15705550172",
                                            "needs_destination": true,
                                            "discovers_destination": false,
                                            "requires_proof": true,
                                            "is_proven": true,
                                            "is_configured_on_the_instance": true,
                                            "disabled_reason": null,
                                            "can_send_proof_code": true,
                                            "proof_code_refusal": null
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/notification-channels/sms"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/notification-channels/{channel}/test": {
            "post": {
                "operationId": "notification-channels-test-store",
                "tags": [
                    "Notification channels"
                ],
                "summary": "Send a test message",
                "description": "Send one message on a channel to find out whether it works.\n\nThis touches no reminder and writes no notification. Nothing here is something the account was owed, so nothing about it belongs in the record of what the account was told.\n\nA channel that is not finished is refused with 422. A channel that is finished but whose service refuses the message answers 422 as well, carrying what came back, and the refusal is counted against the channel exactly as a real send would be.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "channel",
                        "in": "path",
                        "required": true,
                        "description": "Which channel: in_app, email, telegram or sms. Anything else answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "201": {
                        "description": "Whether it got through, and what came back when it did not.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "What happened when we tried.",
                                            "properties": {
                                                "sent": {
                                                    "type": [
                                                        "boolean",
                                                        "null"
                                                    ],
                                                    "description": "Whether the message got through."
                                                },
                                                "reason": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "What the service said when it refused, up to 255 characters, or null when nothing refused."
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "sent": true,
                                        "reason": null
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/notification-preferences": {
            "get": {
                "operationId": "notification-preferences-show",
                "tags": [
                    "Notification channels"
                ],
                "summary": "Get notification preferences",
                "description": "Retrieve the quiet hours, the delivery mode and the zone both are read in.\n\nThese belong to the account rather than to a channel. Which channels are on is a separate thing, and is above.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "responses": {
                    "200": {
                        "description": "The preferences of the account. There is exactly one record, made with the account.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The preference.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always notification_preference. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "quiet_hours_are_enabled": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether there are hours during which nothing may be delivered."
                                                        },
                                                        "quiet_hours_start": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The local time from which nothing may go out, as HH:MM, or null when quiet hours are off."
                                                        },
                                                        "quiet_hours_end": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The local time from which delivery may resume, as HH:MM, or null when quiet hours are off."
                                                        },
                                                        "delivery_mode": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Whether each notification goes out on its own, with immediate, or is folded into one summary a day, with digest."
                                                        },
                                                        "digest_time": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The local time the daily summary is sent, as HH:MM, or null when nothing is folded."
                                                        },
                                                        "digest_weekdays": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "Which days the summary is sent, as numbers from 0 for Sunday to 6 for Saturday, or null for every day."
                                                        },
                                                        "timezone": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The zone quiet hours and the summary hour are read in, up to 64 characters."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "notification_preference",
                                        "id": "17",
                                        "attributes": {
                                            "quiet_hours_are_enabled": true,
                                            "quiet_hours_start": "22:00",
                                            "quiet_hours_end": "08:00",
                                            "delivery_mode": "immediate",
                                            "digest_time": null,
                                            "digest_weekdays": null,
                                            "timezone": "America/New_York"
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/notification-preferences"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "notification-preferences-show-query",
                "tags": [
                    "Notification channels"
                ],
                "summary": "Get notification preferences",
                "description": "Retrieve the quiet hours, the delivery mode and the zone both are read in.\n\nThese belong to the account rather than to a channel. Which channels are on is a separate thing, and is above.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "responses": {
                    "200": {
                        "description": "The preferences of the account. There is exactly one record, made with the account.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The preference.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always notification_preference. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "quiet_hours_are_enabled": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether there are hours during which nothing may be delivered."
                                                        },
                                                        "quiet_hours_start": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The local time from which nothing may go out, as HH:MM, or null when quiet hours are off."
                                                        },
                                                        "quiet_hours_end": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The local time from which delivery may resume, as HH:MM, or null when quiet hours are off."
                                                        },
                                                        "delivery_mode": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Whether each notification goes out on its own, with immediate, or is folded into one summary a day, with digest."
                                                        },
                                                        "digest_time": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The local time the daily summary is sent, as HH:MM, or null when nothing is folded."
                                                        },
                                                        "digest_weekdays": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "Which days the summary is sent, as numbers from 0 for Sunday to 6 for Saturday, or null for every day."
                                                        },
                                                        "timezone": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The zone quiet hours and the summary hour are read in, up to 64 characters."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "notification_preference",
                                        "id": "17",
                                        "attributes": {
                                            "quiet_hours_are_enabled": true,
                                            "quiet_hours_start": "22:00",
                                            "quiet_hours_end": "08:00",
                                            "delivery_mode": "immediate",
                                            "digest_time": null,
                                            "digest_weekdays": null,
                                            "timezone": "America/New_York"
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/notification-preferences"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "put": {
                "operationId": "notification-preferences-update",
                "tags": [
                    "Notification channels"
                ],
                "summary": "Change notification preferences",
                "description": "Change the quiet hours, the delivery mode and the zone.\n\nQuiet hours hold a notification back rather than dropping it: something due at three in the morning goes out when the quiet is over.\n\nAsking for a daily summary without an hour to send it at is refused with 422, and so is a time of day that is not one, or a zone the application does not know.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "quiet_hours_are_enabled": {
                                        "type": "boolean",
                                        "description": "Whether there are hours during which nothing may be delivered. It cannot be null."
                                    },
                                    "quiet_hours_start": {
                                        "type": "string",
                                        "description": "The local time from which nothing may go out, as HH:MM. Needed when quiet hours are on."
                                    },
                                    "quiet_hours_end": {
                                        "type": "string",
                                        "description": "The local time from which delivery may resume, as HH:MM. Needed when quiet hours are on."
                                    },
                                    "delivery_mode": {
                                        "type": "string",
                                        "description": "Either immediate or digest. It cannot be null."
                                    },
                                    "digest_time": {
                                        "type": "string",
                                        "description": "The local time the daily summary is sent, as HH:MM. Needed when the mode is digest."
                                    },
                                    "digest_weekdays": {
                                        "type": "array",
                                        "description": "Which days the summary is sent, as numbers from 0 for Sunday to 6 for Saturday. Null sends it every day."
                                    },
                                    "timezone": {
                                        "type": "string",
                                        "description": "The zone quiet hours and the summary hour are read in. Unlike other fields, null keeps whatever is saved rather than clearing it."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The preferences as they now stand.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The preference.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always notification_preference. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "quiet_hours_are_enabled": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether there are hours during which nothing may be delivered."
                                                        },
                                                        "quiet_hours_start": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The local time from which nothing may go out, as HH:MM, or null when quiet hours are off."
                                                        },
                                                        "quiet_hours_end": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The local time from which delivery may resume, as HH:MM, or null when quiet hours are off."
                                                        },
                                                        "delivery_mode": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Whether each notification goes out on its own, with immediate, or is folded into one summary a day, with digest."
                                                        },
                                                        "digest_time": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The local time the daily summary is sent, as HH:MM, or null when nothing is folded."
                                                        },
                                                        "digest_weekdays": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "Which days the summary is sent, as numbers from 0 for Sunday to 6 for Saturday, or null for every day."
                                                        },
                                                        "timezone": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The zone quiet hours and the summary hour are read in, up to 64 characters."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "notification_preference",
                                        "id": "17",
                                        "attributes": {
                                            "quiet_hours_are_enabled": true,
                                            "quiet_hours_start": "22:00",
                                            "quiet_hours_end": "08:00",
                                            "delivery_mode": "immediate",
                                            "digest_time": null,
                                            "digest_weekdays": null,
                                            "timezone": "America/New_York"
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/notification-preferences"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/relationship-categories": {
            "get": {
                "operationId": "relationship-categories-index",
                "tags": [
                    "Relationship categories"
                ],
                "summary": "List relationship categories",
                "description": "List the categories your account files its relationship types under, in the order you arranged them.\n\nA category groups the list and nothing more. Moving a type into Family does not make it genealogical, and moving a genealogical one out of it does not take that behaviour away.\n\nEvery account starts with five: Family, Romantic, Friendship, Professional and Other. Those five are marked with is_system, may be moved and retired, and can never be renamed or deleted. Any category you add yourself carries none of those restrictions.\n\nRetired categories are listed with the rest, because one that is off is meant to be found again and switched back on.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to answer with.",
                        "schema": {
                            "type": "integer",
                            "default": 1
                        }
                    },
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "How many categories one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused.",
                        "schema": {
                            "type": "integer",
                            "default": 25
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of relationship category objects, and how many there are in all.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The categories on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One category.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always relationship_category. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the category is called. A category the product supplied reads in the language you ask for, until somebody rewrites it, after which their words stand in every language. Up to 255 characters, reduced to plain text, so no markup survives here."
                                                            },
                                                            "position": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "Where the category sits in the settings and in the picker, counting from 1. Retired categories are numbered along with the rest, so one switched back on finds the place it had."
                                                            },
                                                            "is_system": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the product supplied the category with the account. A supplied category may be moved and retired, never renamed and never deleted, because the wording it falls back to belongs to the product."
                                                            },
                                                            "is_active": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the category and the types under it are offered when a new relationship is written. False removes the whole category from that choice and touches nothing already written: every relationship stays readable."
                                                            },
                                                            "type_count": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How many relationship types sit under the category, retired ones counted. It is what decides whether the category may be deleted, since one still holding a type cannot go."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the category was added, as a count of seconds since 1970 rather than a written date."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "relationship_category",
                                            "id": "7d1f4a83-2c06-4e59-9b27-8f3a5d0e6c14",
                                            "attributes": {
                                                "name": "Family",
                                                "position": 1,
                                                "is_system": true,
                                                "is_active": true,
                                                "type_count": 5,
                                                "created_at": 1756252800,
                                                "updated_at": 1756252800
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/relationship-categories/7d1f4a83-2c06-4e59-9b27-8f3a5d0e6c14"
                                            }
                                        },
                                        {
                                            "type": "relationship_category",
                                            "id": "b42e9c07-5a18-4d73-8e60-1c9f2b7a4d35",
                                            "attributes": {
                                                "name": "Neighbourhood",
                                                "position": 6,
                                                "is_system": false,
                                                "is_active": true,
                                                "type_count": 0,
                                                "created_at": 1756339200,
                                                "updated_at": 1756425600
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/relationship-categories/b42e9c07-5a18-4d73-8e60-1c9f2b7a4d35"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 2
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "relationship-categories-index-query",
                "tags": [
                    "Relationship categories"
                ],
                "summary": "List relationship categories",
                "description": "List the categories your account files its relationship types under, in the order you arranged them.\n\nA category groups the list and nothing more. Moving a type into Family does not make it genealogical, and moving a genealogical one out of it does not take that behaviour away.\n\nEvery account starts with five: Family, Romantic, Friendship, Professional and Other. Those five are marked with is_system, may be moved and retired, and can never be renamed or deleted. Any category you add yourself carries none of those restrictions.\n\nRetired categories are listed with the rest, because one that is off is meant to be found again and switched back on.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "page": {
                                        "type": "integer",
                                        "default": 1,
                                        "description": "Which page to answer with."
                                    },
                                    "per_page": {
                                        "type": "integer",
                                        "default": 25,
                                        "description": "How many categories one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "A page of relationship category objects, and how many there are in all.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The categories on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One category.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always relationship_category. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the category is called. A category the product supplied reads in the language you ask for, until somebody rewrites it, after which their words stand in every language. Up to 255 characters, reduced to plain text, so no markup survives here."
                                                            },
                                                            "position": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "Where the category sits in the settings and in the picker, counting from 1. Retired categories are numbered along with the rest, so one switched back on finds the place it had."
                                                            },
                                                            "is_system": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the product supplied the category with the account. A supplied category may be moved and retired, never renamed and never deleted, because the wording it falls back to belongs to the product."
                                                            },
                                                            "is_active": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the category and the types under it are offered when a new relationship is written. False removes the whole category from that choice and touches nothing already written: every relationship stays readable."
                                                            },
                                                            "type_count": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How many relationship types sit under the category, retired ones counted. It is what decides whether the category may be deleted, since one still holding a type cannot go."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the category was added, as a count of seconds since 1970 rather than a written date."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "relationship_category",
                                            "id": "7d1f4a83-2c06-4e59-9b27-8f3a5d0e6c14",
                                            "attributes": {
                                                "name": "Family",
                                                "position": 1,
                                                "is_system": true,
                                                "is_active": true,
                                                "type_count": 5,
                                                "created_at": 1756252800,
                                                "updated_at": 1756252800
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/relationship-categories/7d1f4a83-2c06-4e59-9b27-8f3a5d0e6c14"
                                            }
                                        },
                                        {
                                            "type": "relationship_category",
                                            "id": "b42e9c07-5a18-4d73-8e60-1c9f2b7a4d35",
                                            "attributes": {
                                                "name": "Neighbourhood",
                                                "position": 6,
                                                "is_system": false,
                                                "is_active": true,
                                                "type_count": 0,
                                                "created_at": 1756339200,
                                                "updated_at": 1756425600
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/relationship-categories/b42e9c07-5a18-4d73-8e60-1c9f2b7a4d35"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 2
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "post": {
                "operationId": "relationship-categories-create",
                "tags": [
                    "Relationship categories"
                ],
                "summary": "Add a relationship category",
                "description": "Add a category of your own, when the five the product supplies do not sort your list the way you think of it.\n\nThe category goes at the end of the list and is offered straight away. It holds nothing until you file types under it, and a category holding nothing is a perfectly ordinary state: Other is supplied that way.\n\nA category does no work beyond grouping. Adding one called Family of my own does not make anything filed under it genealogical.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "description": "What the category is called. Up to 255 characters. Markup and surrounding blank space are stripped, and a name left with nothing in it is refused."
                                    }
                                },
                                "required": [
                                    "name"
                                ]
                            },
                            "example": {
                                "name": "Neighbourhood"
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The relationship category object that was added.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The category.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always relationship_category. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the category is called. A category the product supplied reads in the language you ask for, until somebody rewrites it, after which their words stand in every language. Up to 255 characters, reduced to plain text, so no markup survives here."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the category sits in the settings and in the picker, counting from 1. Retired categories are numbered along with the rest, so one switched back on finds the place it had."
                                                        },
                                                        "is_system": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the product supplied the category with the account. A supplied category may be moved and retired, never renamed and never deleted, because the wording it falls back to belongs to the product."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the category and the types under it are offered when a new relationship is written. False removes the whole category from that choice and touches nothing already written: every relationship stays readable."
                                                        },
                                                        "type_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many relationship types sit under the category, retired ones counted. It is what decides whether the category may be deleted, since one still holding a type cannot go."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the category was added, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "relationship_category",
                                        "id": "b42e9c07-5a18-4d73-8e60-1c9f2b7a4d35",
                                        "attributes": {
                                            "name": "Neighbourhood",
                                            "position": 6,
                                            "is_system": false,
                                            "is_active": true,
                                            "type_count": 0,
                                            "created_at": 1756339200,
                                            "updated_at": 1756425600
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/relationship-categories/b42e9c07-5a18-4d73-8e60-1c9f2b7a4d35"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/relationship-categories/{relationshipCategory}": {
            "get": {
                "operationId": "relationship-categories-show",
                "tags": [
                    "Relationship categories"
                ],
                "summary": "Get a relationship category",
                "description": "Retrieve one category: what it is called, where it sits, and how many types it holds.\n\nThe types themselves are not in here. Ask for them at the address below, or list every type of the account at once.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "relationshipCategory",
                        "in": "path",
                        "required": true,
                        "description": "The id of the category. A path that is not a uuid answers 404 without a query being run.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A relationship category object. A category belonging to somebody else answers 404, which is also what a category that never existed answers, and what a deleted one answers.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The category.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always relationship_category. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the category is called. A category the product supplied reads in the language you ask for, until somebody rewrites it, after which their words stand in every language. Up to 255 characters, reduced to plain text, so no markup survives here."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the category sits in the settings and in the picker, counting from 1. Retired categories are numbered along with the rest, so one switched back on finds the place it had."
                                                        },
                                                        "is_system": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the product supplied the category with the account. A supplied category may be moved and retired, never renamed and never deleted, because the wording it falls back to belongs to the product."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the category and the types under it are offered when a new relationship is written. False removes the whole category from that choice and touches nothing already written: every relationship stays readable."
                                                        },
                                                        "type_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many relationship types sit under the category, retired ones counted. It is what decides whether the category may be deleted, since one still holding a type cannot go."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the category was added, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "relationship_category",
                                        "id": "7d1f4a83-2c06-4e59-9b27-8f3a5d0e6c14",
                                        "attributes": {
                                            "name": "Family",
                                            "position": 1,
                                            "is_system": true,
                                            "is_active": true,
                                            "type_count": 5,
                                            "created_at": 1756252800,
                                            "updated_at": 1756252800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/relationship-categories/7d1f4a83-2c06-4e59-9b27-8f3a5d0e6c14"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "relationship-categories-show-query",
                "tags": [
                    "Relationship categories"
                ],
                "summary": "Get a relationship category",
                "description": "Retrieve one category: what it is called, where it sits, and how many types it holds.\n\nThe types themselves are not in here. Ask for them at the address below, or list every type of the account at once.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "relationshipCategory",
                        "in": "path",
                        "required": true,
                        "description": "The id of the category. A path that is not a uuid answers 404 without a query being run.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A relationship category object. A category belonging to somebody else answers 404, which is also what a category that never existed answers, and what a deleted one answers.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The category.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always relationship_category. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the category is called. A category the product supplied reads in the language you ask for, until somebody rewrites it, after which their words stand in every language. Up to 255 characters, reduced to plain text, so no markup survives here."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the category sits in the settings and in the picker, counting from 1. Retired categories are numbered along with the rest, so one switched back on finds the place it had."
                                                        },
                                                        "is_system": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the product supplied the category with the account. A supplied category may be moved and retired, never renamed and never deleted, because the wording it falls back to belongs to the product."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the category and the types under it are offered when a new relationship is written. False removes the whole category from that choice and touches nothing already written: every relationship stays readable."
                                                        },
                                                        "type_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many relationship types sit under the category, retired ones counted. It is what decides whether the category may be deleted, since one still holding a type cannot go."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the category was added, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "relationship_category",
                                        "id": "7d1f4a83-2c06-4e59-9b27-8f3a5d0e6c14",
                                        "attributes": {
                                            "name": "Family",
                                            "position": 1,
                                            "is_system": true,
                                            "is_active": true,
                                            "type_count": 5,
                                            "created_at": 1756252800,
                                            "updated_at": 1756252800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/relationship-categories/7d1f4a83-2c06-4e59-9b27-8f3a5d0e6c14"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "put": {
                "operationId": "relationship-categories-update",
                "tags": [
                    "Relationship categories"
                ],
                "summary": "Rename a relationship category",
                "description": "Change what one of your own categories is called.\n\nA category the product supplied cannot be renamed, and answers 422. Its wording belongs to the product and reads in the language of whoever is looking, which is what would be lost. Move it, retire it, or file your types under a category of your own instead.\n\nThe types under the category are untouched by a rename, and so is where the category sits.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "relationshipCategory",
                        "in": "path",
                        "required": true,
                        "description": "The id of the category. A path that is not a uuid answers 404 without a query being run.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "description": "What the category is called. Up to 255 characters. It cannot be null."
                                    }
                                }
                            },
                            "example": {
                                "name": "Neighbourhood"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The relationship category object as it now reads. A supplied category answers 422.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The category.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always relationship_category. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the category is called. A category the product supplied reads in the language you ask for, until somebody rewrites it, after which their words stand in every language. Up to 255 characters, reduced to plain text, so no markup survives here."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the category sits in the settings and in the picker, counting from 1. Retired categories are numbered along with the rest, so one switched back on finds the place it had."
                                                        },
                                                        "is_system": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the product supplied the category with the account. A supplied category may be moved and retired, never renamed and never deleted, because the wording it falls back to belongs to the product."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the category and the types under it are offered when a new relationship is written. False removes the whole category from that choice and touches nothing already written: every relationship stays readable."
                                                        },
                                                        "type_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many relationship types sit under the category, retired ones counted. It is what decides whether the category may be deleted, since one still holding a type cannot go."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the category was added, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "relationship_category",
                                        "id": "b42e9c07-5a18-4d73-8e60-1c9f2b7a4d35",
                                        "attributes": {
                                            "name": "Neighbourhood",
                                            "position": 6,
                                            "is_system": false,
                                            "is_active": true,
                                            "type_count": 0,
                                            "created_at": 1756339200,
                                            "updated_at": 1756425600
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/relationship-categories/b42e9c07-5a18-4d73-8e60-1c9f2b7a4d35"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "delete": {
                "operationId": "relationship-categories-destroy",
                "tags": [
                    "Relationship categories"
                ],
                "summary": "Delete a relationship category",
                "description": "Remove a category of your own that holds nothing.\n\nTwo categories cannot go. One the product supplied stays. One that still holds a type stays, and the answer says how many it holds, because removing it would take those types with it. Move them elsewhere first, or retire the category instead.\n\nA deletion is recoverable, so an accident is not the end of anything.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "relationshipCategory",
                        "in": "path",
                        "required": true,
                        "description": "The id of the category. A path that is not a uuid answers 404 without a query being run.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Nothing. A supplied category, and one still holding a type, each answer 422 naming that reason, and one belonging to somebody else answers 404."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/relationship-categories/{relationshipCategory}/activation": {
            "put": {
                "operationId": "relationship-categories-activation",
                "tags": [
                    "Relationship categories"
                ],
                "summary": "Offer or retire a relationship category",
                "description": "Say whether a category, and every type under it, may still be chosen for a new relationship.\n\nRetiring a category takes it out of the choice offered when somebody writes a relationship down. It is the tidiest way to put a run of types aside without deciding about each one, and it works on a category the product supplied as readily as on your own.\n\nNothing already written is touched. Every relationship keeps reading with the words it was written with, and the category keeps the place it had, so offering it again puts it back where it was rather than at the end.\n\nSend the state you want rather than asking for a toggle, so sending the same value twice confirms it instead of inverting it.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "relationshipCategory",
                        "in": "path",
                        "required": true,
                        "description": "The id of the category. A path that is not a uuid answers 404 without a query being run.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "is_active": {
                                        "type": "boolean",
                                        "description": "True to offer the category again, false to retire it."
                                    }
                                },
                                "required": [
                                    "is_active"
                                ]
                            },
                            "example": {
                                "is_active": false
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The relationship category object in the state you asked for.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The category.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always relationship_category. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the category is called. A category the product supplied reads in the language you ask for, until somebody rewrites it, after which their words stand in every language. Up to 255 characters, reduced to plain text, so no markup survives here."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the category sits in the settings and in the picker, counting from 1. Retired categories are numbered along with the rest, so one switched back on finds the place it had."
                                                        },
                                                        "is_system": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the product supplied the category with the account. A supplied category may be moved and retired, never renamed and never deleted, because the wording it falls back to belongs to the product."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the category and the types under it are offered when a new relationship is written. False removes the whole category from that choice and touches nothing already written: every relationship stays readable."
                                                        },
                                                        "type_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many relationship types sit under the category, retired ones counted. It is what decides whether the category may be deleted, since one still holding a type cannot go."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the category was added, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "relationship_category",
                                        "id": "7d1f4a83-2c06-4e59-9b27-8f3a5d0e6c14",
                                        "attributes": {
                                            "name": "Family",
                                            "position": 1,
                                            "is_system": true,
                                            "is_active": true,
                                            "type_count": 5,
                                            "created_at": 1756252800,
                                            "updated_at": 1756252800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/relationship-categories/7d1f4a83-2c06-4e59-9b27-8f3a5d0e6c14"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/relationship-categories/{relationshipCategory}/position": {
            "put": {
                "operationId": "relationship-categories-position",
                "tags": [
                    "Relationship categories"
                ],
                "summary": "Move a relationship category",
                "description": "Put a category somewhere else in the list, so the ones you reach for sit at the top.\n\nEvery category of your account is numbered from 1 again once the move is made, retired ones counted among them. A position past the end puts the category last rather than being refused.\n\nA category the product supplied may be moved like any other. Where a category sits has no effect beyond the order things are read in.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "relationshipCategory",
                        "in": "path",
                        "required": true,
                        "description": "The id of the category. A path that is not a uuid answers 404 without a query being run.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "position": {
                                        "type": "integer",
                                        "description": "Where the category should sit, counting from 1."
                                    }
                                },
                                "required": [
                                    "position"
                                ]
                            },
                            "example": {
                                "position": 1
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The relationship category object in its new place.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The category.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always relationship_category. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the category is called. A category the product supplied reads in the language you ask for, until somebody rewrites it, after which their words stand in every language. Up to 255 characters, reduced to plain text, so no markup survives here."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the category sits in the settings and in the picker, counting from 1. Retired categories are numbered along with the rest, so one switched back on finds the place it had."
                                                        },
                                                        "is_system": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the product supplied the category with the account. A supplied category may be moved and retired, never renamed and never deleted, because the wording it falls back to belongs to the product."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the category and the types under it are offered when a new relationship is written. False removes the whole category from that choice and touches nothing already written: every relationship stays readable."
                                                        },
                                                        "type_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many relationship types sit under the category, retired ones counted. It is what decides whether the category may be deleted, since one still holding a type cannot go."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the category was added, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "relationship_category",
                                        "id": "7d1f4a83-2c06-4e59-9b27-8f3a5d0e6c14",
                                        "attributes": {
                                            "name": "Family",
                                            "position": 1,
                                            "is_system": true,
                                            "is_active": true,
                                            "type_count": 5,
                                            "created_at": 1756252800,
                                            "updated_at": 1756252800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/relationship-categories/7d1f4a83-2c06-4e59-9b27-8f3a5d0e6c14"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/relationship-types": {
            "get": {
                "operationId": "relationship-types-index",
                "tags": [
                    "Relationship types"
                ],
                "summary": "List relationship types",
                "description": "List every kind of link your account can put between two people, grouped order first.\n\nA relationship type is the vocabulary your account uses about the people in it: Parent / Child, Sibling, Partner, Friend, Colleague. Every account starts with ten of them under four of the five supplied categories.\n\nThe order is the one the picker offers: the category position first, then the position inside the category. Retired types are listed with the rest, because one that is off is meant to be found again.\n\nTo read one category at a time instead, ask for the types of that category.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to answer with.",
                        "schema": {
                            "type": "integer",
                            "default": 1
                        }
                    },
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "How many types one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused.",
                        "schema": {
                            "type": "integer",
                            "default": 25
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of relationship type objects, and how many there are in all.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The types on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One type.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always relationship_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "relationship_category_id": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "format": "uuid",
                                                                "description": "The category the type is filed under. It groups the list and the picker and has no other effect: moving a type between categories never changes what the product does with it."
                                                            },
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the link is called: Parent / Child, Sibling, Colleague. A type the product supplied reads in the language you ask for, until somebody rewrites it, after which their words stand in every language. Up to 255 characters, reduced to plain text."
                                                            },
                                                            "role_a": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "How the first person relates to the second. In a Parent / Child link the first person is the Parent. It is read in the same way the name is."
                                                            },
                                                            "role_b": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "How the second person relates to the first. A symmetric type carries the same word here as in role_a, and rewording the two never swaps the people over: the first role stays on the first person of every relationship already written."
                                                            },
                                                            "is_symmetric": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether both people read the same word, as Friend does, rather than a different one on each side, as Parent / Child does. It is frozen once the product supplied the type or a relationship uses it, because turning it round would rewrite what people wrote years ago."
                                                            },
                                                            "system_behavior": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Either genealogy_parentage, which feeds the family tree, or romantic, which feeds romantic history, or null. It is attached to the supplied type itself rather than to its name or its category, so renaming one or moving it elsewhere changes the words on screen and nothing more. A type you invent never acquires one."
                                                            },
                                                            "position": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "Where the type sits inside its category, counting from 1. Retired types are numbered along with the rest."
                                                            },
                                                            "is_system": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the product supplied the type with the account. A supplied type may be reworded, moved and retired, never deleted, and its direction never changes."
                                                            },
                                                            "is_active": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the type is offered when a new relationship is written. False stops it being chosen again and touches nothing already written."
                                                            },
                                                            "relationship_count": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How many relationships are written with this type, across every vault of your account. A relationship in the bin is not counted. It decides both whether the type may be deleted and whether its direction may still move."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the type was added, as a count of seconds since 1970 rather than a written date."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "relationship_type",
                                            "id": "3a9c5e21-7b40-4f68-8d13-6e2f0a4b9c57",
                                            "attributes": {
                                                "relationship_category_id": "7d1f4a83-2c06-4e59-9b27-8f3a5d0e6c14",
                                                "name": "Parent / Child",
                                                "role_a": "Parent",
                                                "role_b": "Child",
                                                "is_symmetric": false,
                                                "system_behavior": "genealogy_parentage",
                                                "position": 1,
                                                "is_system": true,
                                                "is_active": true,
                                                "relationship_count": 12,
                                                "created_at": 1756252800,
                                                "updated_at": 1756252800
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/relationship-types/3a9c5e21-7b40-4f68-8d13-6e2f0a4b9c57"
                                            }
                                        },
                                        {
                                            "type": "relationship_type",
                                            "id": "c60d8f14-9a27-4b53-8e01-2d7f5c3a6b48",
                                            "attributes": {
                                                "relationship_category_id": "7d1f4a83-2c06-4e59-9b27-8f3a5d0e6c14",
                                                "name": "Godparent / Godchild",
                                                "role_a": "Godparent",
                                                "role_b": "Godchild",
                                                "is_symmetric": false,
                                                "system_behavior": null,
                                                "position": 6,
                                                "is_system": false,
                                                "is_active": true,
                                                "relationship_count": 0,
                                                "created_at": 1756339200,
                                                "updated_at": 1756425600
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/relationship-types/c60d8f14-9a27-4b53-8e01-2d7f5c3a6b48"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 2
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "relationship-types-index-query",
                "tags": [
                    "Relationship types"
                ],
                "summary": "List relationship types",
                "description": "List every kind of link your account can put between two people, grouped order first.\n\nA relationship type is the vocabulary your account uses about the people in it: Parent / Child, Sibling, Partner, Friend, Colleague. Every account starts with ten of them under four of the five supplied categories.\n\nThe order is the one the picker offers: the category position first, then the position inside the category. Retired types are listed with the rest, because one that is off is meant to be found again.\n\nTo read one category at a time instead, ask for the types of that category.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "page": {
                                        "type": "integer",
                                        "default": 1,
                                        "description": "Which page to answer with."
                                    },
                                    "per_page": {
                                        "type": "integer",
                                        "default": 25,
                                        "description": "How many types one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "A page of relationship type objects, and how many there are in all.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The types on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One type.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always relationship_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "relationship_category_id": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "format": "uuid",
                                                                "description": "The category the type is filed under. It groups the list and the picker and has no other effect: moving a type between categories never changes what the product does with it."
                                                            },
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the link is called: Parent / Child, Sibling, Colleague. A type the product supplied reads in the language you ask for, until somebody rewrites it, after which their words stand in every language. Up to 255 characters, reduced to plain text."
                                                            },
                                                            "role_a": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "How the first person relates to the second. In a Parent / Child link the first person is the Parent. It is read in the same way the name is."
                                                            },
                                                            "role_b": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "How the second person relates to the first. A symmetric type carries the same word here as in role_a, and rewording the two never swaps the people over: the first role stays on the first person of every relationship already written."
                                                            },
                                                            "is_symmetric": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether both people read the same word, as Friend does, rather than a different one on each side, as Parent / Child does. It is frozen once the product supplied the type or a relationship uses it, because turning it round would rewrite what people wrote years ago."
                                                            },
                                                            "system_behavior": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Either genealogy_parentage, which feeds the family tree, or romantic, which feeds romantic history, or null. It is attached to the supplied type itself rather than to its name or its category, so renaming one or moving it elsewhere changes the words on screen and nothing more. A type you invent never acquires one."
                                                            },
                                                            "position": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "Where the type sits inside its category, counting from 1. Retired types are numbered along with the rest."
                                                            },
                                                            "is_system": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the product supplied the type with the account. A supplied type may be reworded, moved and retired, never deleted, and its direction never changes."
                                                            },
                                                            "is_active": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the type is offered when a new relationship is written. False stops it being chosen again and touches nothing already written."
                                                            },
                                                            "relationship_count": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How many relationships are written with this type, across every vault of your account. A relationship in the bin is not counted. It decides both whether the type may be deleted and whether its direction may still move."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the type was added, as a count of seconds since 1970 rather than a written date."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "relationship_type",
                                            "id": "3a9c5e21-7b40-4f68-8d13-6e2f0a4b9c57",
                                            "attributes": {
                                                "relationship_category_id": "7d1f4a83-2c06-4e59-9b27-8f3a5d0e6c14",
                                                "name": "Parent / Child",
                                                "role_a": "Parent",
                                                "role_b": "Child",
                                                "is_symmetric": false,
                                                "system_behavior": "genealogy_parentage",
                                                "position": 1,
                                                "is_system": true,
                                                "is_active": true,
                                                "relationship_count": 12,
                                                "created_at": 1756252800,
                                                "updated_at": 1756252800
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/relationship-types/3a9c5e21-7b40-4f68-8d13-6e2f0a4b9c57"
                                            }
                                        },
                                        {
                                            "type": "relationship_type",
                                            "id": "c60d8f14-9a27-4b53-8e01-2d7f5c3a6b48",
                                            "attributes": {
                                                "relationship_category_id": "7d1f4a83-2c06-4e59-9b27-8f3a5d0e6c14",
                                                "name": "Godparent / Godchild",
                                                "role_a": "Godparent",
                                                "role_b": "Godchild",
                                                "is_symmetric": false,
                                                "system_behavior": null,
                                                "position": 6,
                                                "is_system": false,
                                                "is_active": true,
                                                "relationship_count": 0,
                                                "created_at": 1756339200,
                                                "updated_at": 1756425600
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/relationship-types/c60d8f14-9a27-4b53-8e01-2d7f5c3a6b48"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 2
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "post": {
                "operationId": "relationship-types-create",
                "tags": [
                    "Relationship types"
                ],
                "summary": "Add a relationship type",
                "description": "Add a kind of link the product did not supply, when the ten it ships with fall short.\n\nSay whether both people read the same word or a different one on each side. A symmetric type, Friend for instance, takes one role and reads with it from both sides, so role_b may be left out. A directed type, Godparent / Godchild for instance, takes a role for each side, and the first person always carries role_a.\n\nThe type goes at the end of the category you file it under, and is offered straight away unless you say otherwise. It never acquires a system_behavior: the family tree and romantic history read the types the product supplied, whatever you call yours.\n\nA name another type of your account already carries is refused, so the picker never offers the same word twice.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "relationship_category_id": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "The category to file the type under. A category belonging to somebody else is refused."
                                    },
                                    "name": {
                                        "type": "string",
                                        "description": "What the link is called. Up to 255 characters. Markup and surrounding blank space are stripped, and a name left with nothing in it is refused."
                                    },
                                    "role_a": {
                                        "type": "string",
                                        "description": "How the first person relates to the second. Up to 255 characters."
                                    },
                                    "role_b": {
                                        "type": "string",
                                        "description": "How the second person relates to the first. Required when is_symmetric is false; ignored and set to role_a when it is true."
                                    },
                                    "is_symmetric": {
                                        "type": "boolean",
                                        "description": "Whether both people read the same word. Defaults to true."
                                    },
                                    "is_active": {
                                        "type": "boolean",
                                        "description": "Whether the type is offered for a new relationship. Defaults to true."
                                    }
                                },
                                "required": [
                                    "relationship_category_id",
                                    "name",
                                    "role_a"
                                ]
                            },
                            "example": {
                                "relationship_category_id": "7d1f4a83-2c06-4e59-9b27-8f3a5d0e6c14",
                                "name": "Godparent / Godchild",
                                "role_a": "Godparent",
                                "role_b": "Godchild",
                                "is_symmetric": false,
                                "is_active": true
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The relationship type object that was added.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The type.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always relationship_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "relationship_category_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The category the type is filed under. It groups the list and the picker and has no other effect: moving a type between categories never changes what the product does with it."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the link is called: Parent / Child, Sibling, Colleague. A type the product supplied reads in the language you ask for, until somebody rewrites it, after which their words stand in every language. Up to 255 characters, reduced to plain text."
                                                        },
                                                        "role_a": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How the first person relates to the second. In a Parent / Child link the first person is the Parent. It is read in the same way the name is."
                                                        },
                                                        "role_b": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How the second person relates to the first. A symmetric type carries the same word here as in role_a, and rewording the two never swaps the people over: the first role stays on the first person of every relationship already written."
                                                        },
                                                        "is_symmetric": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether both people read the same word, as Friend does, rather than a different one on each side, as Parent / Child does. It is frozen once the product supplied the type or a relationship uses it, because turning it round would rewrite what people wrote years ago."
                                                        },
                                                        "system_behavior": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either genealogy_parentage, which feeds the family tree, or romantic, which feeds romantic history, or null. It is attached to the supplied type itself rather than to its name or its category, so renaming one or moving it elsewhere changes the words on screen and nothing more. A type you invent never acquires one."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the type sits inside its category, counting from 1. Retired types are numbered along with the rest."
                                                        },
                                                        "is_system": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the product supplied the type with the account. A supplied type may be reworded, moved and retired, never deleted, and its direction never changes."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the type is offered when a new relationship is written. False stops it being chosen again and touches nothing already written."
                                                        },
                                                        "relationship_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many relationships are written with this type, across every vault of your account. A relationship in the bin is not counted. It decides both whether the type may be deleted and whether its direction may still move."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the type was added, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "relationship_type",
                                        "id": "c60d8f14-9a27-4b53-8e01-2d7f5c3a6b48",
                                        "attributes": {
                                            "relationship_category_id": "7d1f4a83-2c06-4e59-9b27-8f3a5d0e6c14",
                                            "name": "Godparent / Godchild",
                                            "role_a": "Godparent",
                                            "role_b": "Godchild",
                                            "is_symmetric": false,
                                            "system_behavior": null,
                                            "position": 6,
                                            "is_system": false,
                                            "is_active": true,
                                            "relationship_count": 0,
                                            "created_at": 1756339200,
                                            "updated_at": 1756425600
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/relationship-types/c60d8f14-9a27-4b53-8e01-2d7f5c3a6b48"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/relationship-categories/{relationshipCategory}/types": {
            "get": {
                "operationId": "relationship-types-by-category",
                "tags": [
                    "Relationship types"
                ],
                "summary": "List the types of one category",
                "description": "List the relationship types filed under one category, in the order you arranged them.\n\nThis is the grouped reading the settings screen shows, one category at a time. The objects are relationship types, described in full in the relationship types reference.\n\nA category holding nothing answers an empty list rather than an error, which is the state Other is supplied in.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "relationshipCategory",
                        "in": "path",
                        "required": true,
                        "description": "The id of the category whose types you want. A category belonging to somebody else answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to answer with.",
                        "schema": {
                            "type": "integer",
                            "default": 1
                        }
                    },
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "How many types one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused.",
                        "schema": {
                            "type": "integer",
                            "default": 25
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of relationship type objects, and how many the category holds in all.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The types on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One type.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always relationship_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "relationship_category_id": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "format": "uuid",
                                                                "description": "The category the type is filed under. It groups the list and the picker and has no other effect: moving a type between categories never changes what the product does with it."
                                                            },
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the link is called: Parent / Child, Sibling, Colleague. A type the product supplied reads in the language you ask for, until somebody rewrites it, after which their words stand in every language. Up to 255 characters, reduced to plain text."
                                                            },
                                                            "role_a": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "How the first person relates to the second. In a Parent / Child link the first person is the Parent. It is read in the same way the name is."
                                                            },
                                                            "role_b": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "How the second person relates to the first. A symmetric type carries the same word here as in role_a, and rewording the two never swaps the people over: the first role stays on the first person of every relationship already written."
                                                            },
                                                            "is_symmetric": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether both people read the same word, as Friend does, rather than a different one on each side, as Parent / Child does. It is frozen once the product supplied the type or a relationship uses it, because turning it round would rewrite what people wrote years ago."
                                                            },
                                                            "system_behavior": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Either genealogy_parentage, which feeds the family tree, or romantic, which feeds romantic history, or null. It is attached to the supplied type itself rather than to its name or its category, so renaming one or moving it elsewhere changes the words on screen and nothing more. A type you invent never acquires one."
                                                            },
                                                            "position": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "Where the type sits inside its category, counting from 1. Retired types are numbered along with the rest."
                                                            },
                                                            "is_system": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the product supplied the type with the account. A supplied type may be reworded, moved and retired, never deleted, and its direction never changes."
                                                            },
                                                            "is_active": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the type is offered when a new relationship is written. False stops it being chosen again and touches nothing already written."
                                                            },
                                                            "relationship_count": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How many relationships are written with this type, across every vault of your account. A relationship in the bin is not counted. It decides both whether the type may be deleted and whether its direction may still move."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the type was added, as a count of seconds since 1970 rather than a written date."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "relationship_type",
                                            "id": "3a9c5e21-7b40-4f68-8d13-6e2f0a4b9c57",
                                            "attributes": {
                                                "relationship_category_id": "7d1f4a83-2c06-4e59-9b27-8f3a5d0e6c14",
                                                "name": "Parent / Child",
                                                "role_a": "Parent",
                                                "role_b": "Child",
                                                "is_symmetric": false,
                                                "system_behavior": "genealogy_parentage",
                                                "position": 1,
                                                "is_system": true,
                                                "is_active": true,
                                                "relationship_count": 12,
                                                "created_at": 1756252800,
                                                "updated_at": 1756252800
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/relationship-types/3a9c5e21-7b40-4f68-8d13-6e2f0a4b9c57"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "relationship-types-by-category-query",
                "tags": [
                    "Relationship types"
                ],
                "summary": "List the types of one category",
                "description": "List the relationship types filed under one category, in the order you arranged them.\n\nThis is the grouped reading the settings screen shows, one category at a time. The objects are relationship types, described in full in the relationship types reference.\n\nA category holding nothing answers an empty list rather than an error, which is the state Other is supplied in.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "relationshipCategory",
                        "in": "path",
                        "required": true,
                        "description": "The id of the category whose types you want. A category belonging to somebody else answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "page": {
                                        "type": "integer",
                                        "default": 1,
                                        "description": "Which page to answer with."
                                    },
                                    "per_page": {
                                        "type": "integer",
                                        "default": 25,
                                        "description": "How many types one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "A page of relationship type objects, and how many the category holds in all.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The types on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One type.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always relationship_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "relationship_category_id": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "format": "uuid",
                                                                "description": "The category the type is filed under. It groups the list and the picker and has no other effect: moving a type between categories never changes what the product does with it."
                                                            },
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the link is called: Parent / Child, Sibling, Colleague. A type the product supplied reads in the language you ask for, until somebody rewrites it, after which their words stand in every language. Up to 255 characters, reduced to plain text."
                                                            },
                                                            "role_a": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "How the first person relates to the second. In a Parent / Child link the first person is the Parent. It is read in the same way the name is."
                                                            },
                                                            "role_b": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "How the second person relates to the first. A symmetric type carries the same word here as in role_a, and rewording the two never swaps the people over: the first role stays on the first person of every relationship already written."
                                                            },
                                                            "is_symmetric": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether both people read the same word, as Friend does, rather than a different one on each side, as Parent / Child does. It is frozen once the product supplied the type or a relationship uses it, because turning it round would rewrite what people wrote years ago."
                                                            },
                                                            "system_behavior": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Either genealogy_parentage, which feeds the family tree, or romantic, which feeds romantic history, or null. It is attached to the supplied type itself rather than to its name or its category, so renaming one or moving it elsewhere changes the words on screen and nothing more. A type you invent never acquires one."
                                                            },
                                                            "position": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "Where the type sits inside its category, counting from 1. Retired types are numbered along with the rest."
                                                            },
                                                            "is_system": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the product supplied the type with the account. A supplied type may be reworded, moved and retired, never deleted, and its direction never changes."
                                                            },
                                                            "is_active": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the type is offered when a new relationship is written. False stops it being chosen again and touches nothing already written."
                                                            },
                                                            "relationship_count": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How many relationships are written with this type, across every vault of your account. A relationship in the bin is not counted. It decides both whether the type may be deleted and whether its direction may still move."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the type was added, as a count of seconds since 1970 rather than a written date."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "relationship_type",
                                            "id": "3a9c5e21-7b40-4f68-8d13-6e2f0a4b9c57",
                                            "attributes": {
                                                "relationship_category_id": "7d1f4a83-2c06-4e59-9b27-8f3a5d0e6c14",
                                                "name": "Parent / Child",
                                                "role_a": "Parent",
                                                "role_b": "Child",
                                                "is_symmetric": false,
                                                "system_behavior": "genealogy_parentage",
                                                "position": 1,
                                                "is_system": true,
                                                "is_active": true,
                                                "relationship_count": 12,
                                                "created_at": 1756252800,
                                                "updated_at": 1756252800
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/relationship-types/3a9c5e21-7b40-4f68-8d13-6e2f0a4b9c57"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/relationship-types/{relationshipType}": {
            "get": {
                "operationId": "relationship-types-show",
                "tags": [
                    "Relationship types"
                ],
                "summary": "Get a relationship type",
                "description": "Retrieve one kind of link: how it reads from each side, and how many relationships use it.\n\nThe relationships written with the type are not in here. This is the vocabulary rather than what was said with it.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "relationshipType",
                        "in": "path",
                        "required": true,
                        "description": "The id of the type. A path that is not a uuid answers 404 without a query being run.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A relationship type object. A type belonging to somebody else answers 404, which is also what a type that never existed answers, and what a deleted one answers.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The type.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always relationship_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "relationship_category_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The category the type is filed under. It groups the list and the picker and has no other effect: moving a type between categories never changes what the product does with it."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the link is called: Parent / Child, Sibling, Colleague. A type the product supplied reads in the language you ask for, until somebody rewrites it, after which their words stand in every language. Up to 255 characters, reduced to plain text."
                                                        },
                                                        "role_a": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How the first person relates to the second. In a Parent / Child link the first person is the Parent. It is read in the same way the name is."
                                                        },
                                                        "role_b": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How the second person relates to the first. A symmetric type carries the same word here as in role_a, and rewording the two never swaps the people over: the first role stays on the first person of every relationship already written."
                                                        },
                                                        "is_symmetric": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether both people read the same word, as Friend does, rather than a different one on each side, as Parent / Child does. It is frozen once the product supplied the type or a relationship uses it, because turning it round would rewrite what people wrote years ago."
                                                        },
                                                        "system_behavior": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either genealogy_parentage, which feeds the family tree, or romantic, which feeds romantic history, or null. It is attached to the supplied type itself rather than to its name or its category, so renaming one or moving it elsewhere changes the words on screen and nothing more. A type you invent never acquires one."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the type sits inside its category, counting from 1. Retired types are numbered along with the rest."
                                                        },
                                                        "is_system": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the product supplied the type with the account. A supplied type may be reworded, moved and retired, never deleted, and its direction never changes."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the type is offered when a new relationship is written. False stops it being chosen again and touches nothing already written."
                                                        },
                                                        "relationship_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many relationships are written with this type, across every vault of your account. A relationship in the bin is not counted. It decides both whether the type may be deleted and whether its direction may still move."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the type was added, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "relationship_type",
                                        "id": "3a9c5e21-7b40-4f68-8d13-6e2f0a4b9c57",
                                        "attributes": {
                                            "relationship_category_id": "7d1f4a83-2c06-4e59-9b27-8f3a5d0e6c14",
                                            "name": "Parent / Child",
                                            "role_a": "Parent",
                                            "role_b": "Child",
                                            "is_symmetric": false,
                                            "system_behavior": "genealogy_parentage",
                                            "position": 1,
                                            "is_system": true,
                                            "is_active": true,
                                            "relationship_count": 12,
                                            "created_at": 1756252800,
                                            "updated_at": 1756252800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/relationship-types/3a9c5e21-7b40-4f68-8d13-6e2f0a4b9c57"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "relationship-types-show-query",
                "tags": [
                    "Relationship types"
                ],
                "summary": "Get a relationship type",
                "description": "Retrieve one kind of link: how it reads from each side, and how many relationships use it.\n\nThe relationships written with the type are not in here. This is the vocabulary rather than what was said with it.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "relationshipType",
                        "in": "path",
                        "required": true,
                        "description": "The id of the type. A path that is not a uuid answers 404 without a query being run.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A relationship type object. A type belonging to somebody else answers 404, which is also what a type that never existed answers, and what a deleted one answers.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The type.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always relationship_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "relationship_category_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The category the type is filed under. It groups the list and the picker and has no other effect: moving a type between categories never changes what the product does with it."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the link is called: Parent / Child, Sibling, Colleague. A type the product supplied reads in the language you ask for, until somebody rewrites it, after which their words stand in every language. Up to 255 characters, reduced to plain text."
                                                        },
                                                        "role_a": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How the first person relates to the second. In a Parent / Child link the first person is the Parent. It is read in the same way the name is."
                                                        },
                                                        "role_b": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How the second person relates to the first. A symmetric type carries the same word here as in role_a, and rewording the two never swaps the people over: the first role stays on the first person of every relationship already written."
                                                        },
                                                        "is_symmetric": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether both people read the same word, as Friend does, rather than a different one on each side, as Parent / Child does. It is frozen once the product supplied the type or a relationship uses it, because turning it round would rewrite what people wrote years ago."
                                                        },
                                                        "system_behavior": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either genealogy_parentage, which feeds the family tree, or romantic, which feeds romantic history, or null. It is attached to the supplied type itself rather than to its name or its category, so renaming one or moving it elsewhere changes the words on screen and nothing more. A type you invent never acquires one."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the type sits inside its category, counting from 1. Retired types are numbered along with the rest."
                                                        },
                                                        "is_system": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the product supplied the type with the account. A supplied type may be reworded, moved and retired, never deleted, and its direction never changes."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the type is offered when a new relationship is written. False stops it being chosen again and touches nothing already written."
                                                        },
                                                        "relationship_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many relationships are written with this type, across every vault of your account. A relationship in the bin is not counted. It decides both whether the type may be deleted and whether its direction may still move."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the type was added, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "relationship_type",
                                        "id": "3a9c5e21-7b40-4f68-8d13-6e2f0a4b9c57",
                                        "attributes": {
                                            "relationship_category_id": "7d1f4a83-2c06-4e59-9b27-8f3a5d0e6c14",
                                            "name": "Parent / Child",
                                            "role_a": "Parent",
                                            "role_b": "Child",
                                            "is_symmetric": false,
                                            "system_behavior": "genealogy_parentage",
                                            "position": 1,
                                            "is_system": true,
                                            "is_active": true,
                                            "relationship_count": 12,
                                            "created_at": 1756252800,
                                            "updated_at": 1756252800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/relationship-types/3a9c5e21-7b40-4f68-8d13-6e2f0a4b9c57"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "put": {
                "operationId": "relationship-types-update",
                "tags": [
                    "Relationship types"
                ],
                "summary": "Reword a relationship type",
                "description": "Change what a type is called, how it reads from each side, and which category it sits in.\n\nThis works on a type the product supplied as readily as on one you added. A French household preferring Conjoint to Spouse writes it here, and what the product does with that type is untouched: its system_behavior, its direction and its identity all stay.\n\nRewording the two roles of a directed type never swaps the people over. The first person keeps role_a in every relationship already written, so correcting a word cannot quietly turn parents into children.\n\nThe direction stays as it is unless you send is_symmetric. Send it against a type the product supplied, or one that relationships already use, and the request is refused rather than quietly ignored, because turning a type round would rewrite what people wrote years ago.\n\nWhether the type is offered, and where it sits, are not changed here. Each has an endpoint of its own below.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "relationshipType",
                        "in": "path",
                        "required": true,
                        "description": "The id of the type. A path that is not a uuid answers 404 without a query being run.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "relationship_category_id": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "The category the type sits in. Moving it between categories changes nothing about what the product does with it. It cannot be null."
                                    },
                                    "name": {
                                        "type": "string",
                                        "description": "What the link is called. A name another type of your account carries is refused. It cannot be null."
                                    },
                                    "role_a": {
                                        "type": "string",
                                        "description": "How the first person relates to the second. It cannot be null."
                                    },
                                    "role_b": {
                                        "type": "string",
                                        "description": "How the second person relates to the first. Left out, it keeps the role it has rather than copying role_a. It cannot be null while the type is directed."
                                    },
                                    "is_symmetric": {
                                        "type": "boolean",
                                        "description": "Send it only to change the direction. Left out, the direction holds. Refused for a supplied type and for one in use."
                                    }
                                }
                            },
                            "example": {
                                "relationship_category_id": "7d1f4a83-2c06-4e59-9b27-8f3a5d0e6c14",
                                "name": "Godparent / Godchild",
                                "role_a": "Godparent",
                                "role_b": "Godchild",
                                "is_symmetric": false
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The relationship type object as it now reads.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The type.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always relationship_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "relationship_category_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The category the type is filed under. It groups the list and the picker and has no other effect: moving a type between categories never changes what the product does with it."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the link is called: Parent / Child, Sibling, Colleague. A type the product supplied reads in the language you ask for, until somebody rewrites it, after which their words stand in every language. Up to 255 characters, reduced to plain text."
                                                        },
                                                        "role_a": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How the first person relates to the second. In a Parent / Child link the first person is the Parent. It is read in the same way the name is."
                                                        },
                                                        "role_b": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How the second person relates to the first. A symmetric type carries the same word here as in role_a, and rewording the two never swaps the people over: the first role stays on the first person of every relationship already written."
                                                        },
                                                        "is_symmetric": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether both people read the same word, as Friend does, rather than a different one on each side, as Parent / Child does. It is frozen once the product supplied the type or a relationship uses it, because turning it round would rewrite what people wrote years ago."
                                                        },
                                                        "system_behavior": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either genealogy_parentage, which feeds the family tree, or romantic, which feeds romantic history, or null. It is attached to the supplied type itself rather than to its name or its category, so renaming one or moving it elsewhere changes the words on screen and nothing more. A type you invent never acquires one."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the type sits inside its category, counting from 1. Retired types are numbered along with the rest."
                                                        },
                                                        "is_system": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the product supplied the type with the account. A supplied type may be reworded, moved and retired, never deleted, and its direction never changes."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the type is offered when a new relationship is written. False stops it being chosen again and touches nothing already written."
                                                        },
                                                        "relationship_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many relationships are written with this type, across every vault of your account. A relationship in the bin is not counted. It decides both whether the type may be deleted and whether its direction may still move."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the type was added, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "relationship_type",
                                        "id": "c60d8f14-9a27-4b53-8e01-2d7f5c3a6b48",
                                        "attributes": {
                                            "relationship_category_id": "7d1f4a83-2c06-4e59-9b27-8f3a5d0e6c14",
                                            "name": "Godparent / Godchild",
                                            "role_a": "Godparent",
                                            "role_b": "Godchild",
                                            "is_symmetric": false,
                                            "system_behavior": null,
                                            "position": 6,
                                            "is_system": false,
                                            "is_active": true,
                                            "relationship_count": 0,
                                            "created_at": 1756339200,
                                            "updated_at": 1756425600
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/relationship-types/c60d8f14-9a27-4b53-8e01-2d7f5c3a6b48"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "delete": {
                "operationId": "relationship-types-destroy",
                "tags": [
                    "Relationship types"
                ],
                "summary": "Delete a relationship type",
                "description": "Remove a type you added and never used.\n\nTwo types cannot go. One the product supplied stays, because the family tree and romantic history are written against it. One that relationships already use stays, because removing it would take the words off links somebody wrote down. Both answer 422 and say which it is.\n\nStopping the type being offered is the answer in either case: it leaves the picker, and every relationship written with it keeps reading exactly as before.\n\nA deletion is recoverable, so an accident is not the end of anything.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "relationshipType",
                        "in": "path",
                        "required": true,
                        "description": "The id of the type. A path that is not a uuid answers 404 without a query being run.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Nothing. A type that is supplied or in use answers 422 naming that reason, and one belonging to somebody else answers 404."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/relationship-types/{relationshipType}/activation": {
            "put": {
                "operationId": "relationship-types-activation",
                "tags": [
                    "Relationship types"
                ],
                "summary": "Offer or retire a relationship type",
                "description": "Say whether a type may still be chosen when a new relationship is written.\n\nThis is the answer wherever deletion is refused. A type the product supplied cannot go, and neither can one that relationships already use, but either can be retired, which takes it out of the choice and leaves every relationship written with it reading exactly as before.\n\nThe type keeps the place it had, so offering it again puts it back where it was rather than at the end. Its wording is untouched.\n\nSend the state you want rather than asking for a toggle, so sending the same value twice confirms it instead of inverting it.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "relationshipType",
                        "in": "path",
                        "required": true,
                        "description": "The id of the type. A path that is not a uuid answers 404 without a query being run.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "is_active": {
                                        "type": "boolean",
                                        "description": "True to offer the type again, false to retire it."
                                    }
                                },
                                "required": [
                                    "is_active"
                                ]
                            },
                            "example": {
                                "is_active": false
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The relationship type object in the state you asked for.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The type.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always relationship_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "relationship_category_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The category the type is filed under. It groups the list and the picker and has no other effect: moving a type between categories never changes what the product does with it."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the link is called: Parent / Child, Sibling, Colleague. A type the product supplied reads in the language you ask for, until somebody rewrites it, after which their words stand in every language. Up to 255 characters, reduced to plain text."
                                                        },
                                                        "role_a": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How the first person relates to the second. In a Parent / Child link the first person is the Parent. It is read in the same way the name is."
                                                        },
                                                        "role_b": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How the second person relates to the first. A symmetric type carries the same word here as in role_a, and rewording the two never swaps the people over: the first role stays on the first person of every relationship already written."
                                                        },
                                                        "is_symmetric": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether both people read the same word, as Friend does, rather than a different one on each side, as Parent / Child does. It is frozen once the product supplied the type or a relationship uses it, because turning it round would rewrite what people wrote years ago."
                                                        },
                                                        "system_behavior": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either genealogy_parentage, which feeds the family tree, or romantic, which feeds romantic history, or null. It is attached to the supplied type itself rather than to its name or its category, so renaming one or moving it elsewhere changes the words on screen and nothing more. A type you invent never acquires one."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the type sits inside its category, counting from 1. Retired types are numbered along with the rest."
                                                        },
                                                        "is_system": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the product supplied the type with the account. A supplied type may be reworded, moved and retired, never deleted, and its direction never changes."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the type is offered when a new relationship is written. False stops it being chosen again and touches nothing already written."
                                                        },
                                                        "relationship_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many relationships are written with this type, across every vault of your account. A relationship in the bin is not counted. It decides both whether the type may be deleted and whether its direction may still move."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the type was added, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "relationship_type",
                                        "id": "3a9c5e21-7b40-4f68-8d13-6e2f0a4b9c57",
                                        "attributes": {
                                            "relationship_category_id": "7d1f4a83-2c06-4e59-9b27-8f3a5d0e6c14",
                                            "name": "Parent / Child",
                                            "role_a": "Parent",
                                            "role_b": "Child",
                                            "is_symmetric": false,
                                            "system_behavior": "genealogy_parentage",
                                            "position": 1,
                                            "is_system": true,
                                            "is_active": true,
                                            "relationship_count": 12,
                                            "created_at": 1756252800,
                                            "updated_at": 1756252800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/relationship-types/3a9c5e21-7b40-4f68-8d13-6e2f0a4b9c57"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/relationship-types/{relationshipType}/position": {
            "put": {
                "operationId": "relationship-types-position",
                "tags": [
                    "Relationship types"
                ],
                "summary": "Move a relationship type",
                "description": "Put a type somewhere else inside its category, so the ones you use most sit at the top of the picker.\n\nA type moves inside the category it is filed under, and only the types of that category are renumbered from 1, retired ones counted among them. A position past the end puts the type last rather than being refused.\n\nTo move a type into a different category, reword it and send the category you want instead. This endpoint only changes the order.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "relationshipType",
                        "in": "path",
                        "required": true,
                        "description": "The id of the type. A path that is not a uuid answers 404 without a query being run.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "position": {
                                        "type": "integer",
                                        "description": "Where the type should sit inside its category, counting from 1."
                                    }
                                },
                                "required": [
                                    "position"
                                ]
                            },
                            "example": {
                                "position": 1
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The relationship type object in its new place.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The type.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always relationship_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "relationship_category_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The category the type is filed under. It groups the list and the picker and has no other effect: moving a type between categories never changes what the product does with it."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the link is called: Parent / Child, Sibling, Colleague. A type the product supplied reads in the language you ask for, until somebody rewrites it, after which their words stand in every language. Up to 255 characters, reduced to plain text."
                                                        },
                                                        "role_a": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How the first person relates to the second. In a Parent / Child link the first person is the Parent. It is read in the same way the name is."
                                                        },
                                                        "role_b": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How the second person relates to the first. A symmetric type carries the same word here as in role_a, and rewording the two never swaps the people over: the first role stays on the first person of every relationship already written."
                                                        },
                                                        "is_symmetric": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether both people read the same word, as Friend does, rather than a different one on each side, as Parent / Child does. It is frozen once the product supplied the type or a relationship uses it, because turning it round would rewrite what people wrote years ago."
                                                        },
                                                        "system_behavior": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Either genealogy_parentage, which feeds the family tree, or romantic, which feeds romantic history, or null. It is attached to the supplied type itself rather than to its name or its category, so renaming one or moving it elsewhere changes the words on screen and nothing more. A type you invent never acquires one."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the type sits inside its category, counting from 1. Retired types are numbered along with the rest."
                                                        },
                                                        "is_system": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the product supplied the type with the account. A supplied type may be reworded, moved and retired, never deleted, and its direction never changes."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the type is offered when a new relationship is written. False stops it being chosen again and touches nothing already written."
                                                        },
                                                        "relationship_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many relationships are written with this type, across every vault of your account. A relationship in the bin is not counted. It decides both whether the type may be deleted and whether its direction may still move."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the type was added, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "relationship_type",
                                        "id": "3a9c5e21-7b40-4f68-8d13-6e2f0a4b9c57",
                                        "attributes": {
                                            "relationship_category_id": "7d1f4a83-2c06-4e59-9b27-8f3a5d0e6c14",
                                            "name": "Parent / Child",
                                            "role_a": "Parent",
                                            "role_b": "Child",
                                            "is_symmetric": false,
                                            "system_behavior": "genealogy_parentage",
                                            "position": 1,
                                            "is_system": true,
                                            "is_active": true,
                                            "relationship_count": 12,
                                            "created_at": 1756252800,
                                            "updated_at": 1756252800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/relationship-types/3a9c5e21-7b40-4f68-8d13-6e2f0a4b9c57"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/life-event-categories": {
            "get": {
                "operationId": "life-event-categories-index",
                "tags": [
                    "Life event categories"
                ],
                "summary": "List life event categories",
                "description": "List the categories your account files its life event natures under, in the order you arranged them.\n\nA category groups the vocabulary in settings and pickers, filters the journal and gives aggregate statistics a level to count at. It never decides which fields a life event carries, who participated, or how it is shared. Moving a nature between categories changes how its life events are grouped, including past ones, and changes no recorded fact.\n\nEvery account starts with eight: Relationships and family, Work and education, Health and wellbeing, Home and daily life, Leisure and culture, Travel and experiences, Personal and Other. Other is the fallback, so a nature is never left unclassified. All eight are marked with is_system, which stops them being deleted and nothing else.\n\nRetired categories are listed with the rest, because one that is off is meant to be found again and switched back on.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to answer with.",
                        "schema": {
                            "type": "integer",
                            "default": 1
                        }
                    },
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "How many categories one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused.",
                        "schema": {
                            "type": "integer",
                            "default": 25
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of life event category objects, and how many there are in all.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The categories on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One category.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always life_event_category. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the category is called. A category the product supplied reads in the language you ask for, until somebody renames it, after which their words stand in every language. Up to 255 characters, reduced to plain text, so no markup survives here."
                                                            },
                                                            "position": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "Where the category sits in the settings, the pickers and the journal filters, counting from 1. Retired categories are numbered along with the rest, so one switched back on finds the place it had."
                                                            },
                                                            "is_system": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the product supplied the category with the account. It governs one thing and one thing only: a supplied category cannot be deleted. It may be renamed, moved and retired like any other."
                                                            },
                                                            "is_active": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the category and the natures under it are offered when a life event is recorded. False removes the whole category from that choice and touches nothing already written."
                                                            },
                                                            "life_event_type_count": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How many life event natures are filed under the category, retired ones counted. It is what decides whether the category may be deleted."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the category was added, as a count of seconds since 1970 rather than a written date."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "life_event_category",
                                            "id": "5f8b3c21-9d07-4a64-8e12-7b0a4d6c3e95",
                                            "attributes": {
                                                "name": "Relationships and family",
                                                "position": 1,
                                                "is_system": true,
                                                "is_active": true,
                                                "life_event_type_count": 0,
                                                "created_at": 1756252800,
                                                "updated_at": 1756252800
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/life-event-categories/5f8b3c21-9d07-4a64-8e12-7b0a4d6c3e95"
                                            }
                                        },
                                        {
                                            "type": "life_event_category",
                                            "id": "a71d6e04-2b58-4c39-9f80-3e5c1a7b2d46",
                                            "attributes": {
                                                "name": "Volunteering",
                                                "position": 9,
                                                "is_system": false,
                                                "is_active": true,
                                                "life_event_type_count": 0,
                                                "created_at": 1756339200,
                                                "updated_at": 1756425600
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/life-event-categories/a71d6e04-2b58-4c39-9f80-3e5c1a7b2d46"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 2
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "life-event-categories-index-query",
                "tags": [
                    "Life event categories"
                ],
                "summary": "List life event categories",
                "description": "List the categories your account files its life event natures under, in the order you arranged them.\n\nA category groups the vocabulary in settings and pickers, filters the journal and gives aggregate statistics a level to count at. It never decides which fields a life event carries, who participated, or how it is shared. Moving a nature between categories changes how its life events are grouped, including past ones, and changes no recorded fact.\n\nEvery account starts with eight: Relationships and family, Work and education, Health and wellbeing, Home and daily life, Leisure and culture, Travel and experiences, Personal and Other. Other is the fallback, so a nature is never left unclassified. All eight are marked with is_system, which stops them being deleted and nothing else.\n\nRetired categories are listed with the rest, because one that is off is meant to be found again and switched back on.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "page": {
                                        "type": "integer",
                                        "default": 1,
                                        "description": "Which page to answer with."
                                    },
                                    "per_page": {
                                        "type": "integer",
                                        "default": 25,
                                        "description": "How many categories one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "A page of life event category objects, and how many there are in all.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The categories on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One category.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always life_event_category. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the category is called. A category the product supplied reads in the language you ask for, until somebody renames it, after which their words stand in every language. Up to 255 characters, reduced to plain text, so no markup survives here."
                                                            },
                                                            "position": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "Where the category sits in the settings, the pickers and the journal filters, counting from 1. Retired categories are numbered along with the rest, so one switched back on finds the place it had."
                                                            },
                                                            "is_system": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the product supplied the category with the account. It governs one thing and one thing only: a supplied category cannot be deleted. It may be renamed, moved and retired like any other."
                                                            },
                                                            "is_active": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the category and the natures under it are offered when a life event is recorded. False removes the whole category from that choice and touches nothing already written."
                                                            },
                                                            "life_event_type_count": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How many life event natures are filed under the category, retired ones counted. It is what decides whether the category may be deleted."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the category was added, as a count of seconds since 1970 rather than a written date."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "life_event_category",
                                            "id": "5f8b3c21-9d07-4a64-8e12-7b0a4d6c3e95",
                                            "attributes": {
                                                "name": "Relationships and family",
                                                "position": 1,
                                                "is_system": true,
                                                "is_active": true,
                                                "life_event_type_count": 0,
                                                "created_at": 1756252800,
                                                "updated_at": 1756252800
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/life-event-categories/5f8b3c21-9d07-4a64-8e12-7b0a4d6c3e95"
                                            }
                                        },
                                        {
                                            "type": "life_event_category",
                                            "id": "a71d6e04-2b58-4c39-9f80-3e5c1a7b2d46",
                                            "attributes": {
                                                "name": "Volunteering",
                                                "position": 9,
                                                "is_system": false,
                                                "is_active": true,
                                                "life_event_type_count": 0,
                                                "created_at": 1756339200,
                                                "updated_at": 1756425600
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/life-event-categories/a71d6e04-2b58-4c39-9f80-3e5c1a7b2d46"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 2
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "post": {
                "operationId": "life-event-categories-create",
                "tags": [
                    "Life event categories"
                ],
                "summary": "Add a life event category",
                "description": "Add a category of your own, when the eight the product supplies do not sort your vocabulary the way you think of it.\n\nThe category goes at the end of the list and is offered straight away. It holds nothing until natures are filed under it, and a category holding nothing is a perfectly ordinary state: Other is supplied that way.\n\nA category does no work beyond grouping, filtering and counting. Adding one called Health changes no life event behaviour. Contact history is determined by participants, not by categories or natures.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "description": "What the category is called. Up to 255 characters. Markup and surrounding blank space are stripped, and a name left with nothing in it is refused."
                                    }
                                },
                                "required": [
                                    "name"
                                ]
                            },
                            "example": {
                                "name": "Volunteering"
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The life event category object that was added.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The category.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always life_event_category. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the category is called. A category the product supplied reads in the language you ask for, until somebody renames it, after which their words stand in every language. Up to 255 characters, reduced to plain text, so no markup survives here."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the category sits in the settings, the pickers and the journal filters, counting from 1. Retired categories are numbered along with the rest, so one switched back on finds the place it had."
                                                        },
                                                        "is_system": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the product supplied the category with the account. It governs one thing and one thing only: a supplied category cannot be deleted. It may be renamed, moved and retired like any other."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the category and the natures under it are offered when a life event is recorded. False removes the whole category from that choice and touches nothing already written."
                                                        },
                                                        "life_event_type_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many life event natures are filed under the category, retired ones counted. It is what decides whether the category may be deleted."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the category was added, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "life_event_category",
                                        "id": "a71d6e04-2b58-4c39-9f80-3e5c1a7b2d46",
                                        "attributes": {
                                            "name": "Volunteering",
                                            "position": 9,
                                            "is_system": false,
                                            "is_active": true,
                                            "life_event_type_count": 0,
                                            "created_at": 1756339200,
                                            "updated_at": 1756425600
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/life-event-categories/a71d6e04-2b58-4c39-9f80-3e5c1a7b2d46"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/life-event-categories/{lifeEventCategory}": {
            "get": {
                "operationId": "life-event-categories-show",
                "tags": [
                    "Life event categories"
                ],
                "summary": "Get a life event category",
                "description": "Retrieve one category: what it is called, where it sits, and how many natures it holds.\n\nThe natures themselves are not in here, only how many there are. Ask for the types of the category to read them.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "lifeEventCategory",
                        "in": "path",
                        "required": true,
                        "description": "The id of the category. A path that is not a uuid answers 404 without a query being run.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A life event category object. A category belonging to somebody else answers 404, which is also what a category that never existed answers, and what a deleted one answers.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The category.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always life_event_category. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the category is called. A category the product supplied reads in the language you ask for, until somebody renames it, after which their words stand in every language. Up to 255 characters, reduced to plain text, so no markup survives here."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the category sits in the settings, the pickers and the journal filters, counting from 1. Retired categories are numbered along with the rest, so one switched back on finds the place it had."
                                                        },
                                                        "is_system": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the product supplied the category with the account. It governs one thing and one thing only: a supplied category cannot be deleted. It may be renamed, moved and retired like any other."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the category and the natures under it are offered when a life event is recorded. False removes the whole category from that choice and touches nothing already written."
                                                        },
                                                        "life_event_type_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many life event natures are filed under the category, retired ones counted. It is what decides whether the category may be deleted."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the category was added, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "life_event_category",
                                        "id": "5f8b3c21-9d07-4a64-8e12-7b0a4d6c3e95",
                                        "attributes": {
                                            "name": "Relationships and family",
                                            "position": 1,
                                            "is_system": true,
                                            "is_active": true,
                                            "life_event_type_count": 0,
                                            "created_at": 1756252800,
                                            "updated_at": 1756252800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/life-event-categories/5f8b3c21-9d07-4a64-8e12-7b0a4d6c3e95"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "life-event-categories-show-query",
                "tags": [
                    "Life event categories"
                ],
                "summary": "Get a life event category",
                "description": "Retrieve one category: what it is called, where it sits, and how many natures it holds.\n\nThe natures themselves are not in here, only how many there are. Ask for the types of the category to read them.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "lifeEventCategory",
                        "in": "path",
                        "required": true,
                        "description": "The id of the category. A path that is not a uuid answers 404 without a query being run.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A life event category object. A category belonging to somebody else answers 404, which is also what a category that never existed answers, and what a deleted one answers.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The category.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always life_event_category. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the category is called. A category the product supplied reads in the language you ask for, until somebody renames it, after which their words stand in every language. Up to 255 characters, reduced to plain text, so no markup survives here."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the category sits in the settings, the pickers and the journal filters, counting from 1. Retired categories are numbered along with the rest, so one switched back on finds the place it had."
                                                        },
                                                        "is_system": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the product supplied the category with the account. It governs one thing and one thing only: a supplied category cannot be deleted. It may be renamed, moved and retired like any other."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the category and the natures under it are offered when a life event is recorded. False removes the whole category from that choice and touches nothing already written."
                                                        },
                                                        "life_event_type_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many life event natures are filed under the category, retired ones counted. It is what decides whether the category may be deleted."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the category was added, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "life_event_category",
                                        "id": "5f8b3c21-9d07-4a64-8e12-7b0a4d6c3e95",
                                        "attributes": {
                                            "name": "Relationships and family",
                                            "position": 1,
                                            "is_system": true,
                                            "is_active": true,
                                            "life_event_type_count": 0,
                                            "created_at": 1756252800,
                                            "updated_at": 1756252800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/life-event-categories/5f8b3c21-9d07-4a64-8e12-7b0a4d6c3e95"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "put": {
                "operationId": "life-event-categories-update",
                "tags": [
                    "Life event categories"
                ],
                "summary": "Rename a life event category",
                "description": "Change what a category is called, whether the product supplied it or you added it.\n\nA category the product supplied is renamed like any other. is_system stops a category being deleted and stops nothing else, so a French household preferring Santé to Health and wellbeing writes it here.\n\nWhat the product does with the category is untouched: its stable identity, its place in the order and whether it is offered all stay, and nothing filed under it moves.\n\nOnce you write your own words they stand in every language. The wording the product supplied reads in the language of whoever is looking, and renaming gives that up, which is the bargain every renameable supplied record makes here.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "lifeEventCategory",
                        "in": "path",
                        "required": true,
                        "description": "The id of the category. A path that is not a uuid answers 404 without a query being run.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "description": "What the category is called. Up to 255 characters. It cannot be null."
                                    }
                                }
                            },
                            "example": {
                                "name": "Volunteering"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The life event category object as it now reads.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The category.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always life_event_category. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the category is called. A category the product supplied reads in the language you ask for, until somebody renames it, after which their words stand in every language. Up to 255 characters, reduced to plain text, so no markup survives here."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the category sits in the settings, the pickers and the journal filters, counting from 1. Retired categories are numbered along with the rest, so one switched back on finds the place it had."
                                                        },
                                                        "is_system": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the product supplied the category with the account. It governs one thing and one thing only: a supplied category cannot be deleted. It may be renamed, moved and retired like any other."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the category and the natures under it are offered when a life event is recorded. False removes the whole category from that choice and touches nothing already written."
                                                        },
                                                        "life_event_type_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many life event natures are filed under the category, retired ones counted. It is what decides whether the category may be deleted."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the category was added, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "life_event_category",
                                        "id": "a71d6e04-2b58-4c39-9f80-3e5c1a7b2d46",
                                        "attributes": {
                                            "name": "Volunteering",
                                            "position": 9,
                                            "is_system": false,
                                            "is_active": true,
                                            "life_event_type_count": 0,
                                            "created_at": 1756339200,
                                            "updated_at": 1756425600
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/life-event-categories/a71d6e04-2b58-4c39-9f80-3e5c1a7b2d46"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "delete": {
                "operationId": "life-event-categories-destroy",
                "tags": [
                    "Life event categories"
                ],
                "summary": "Delete a life event category",
                "description": "Remove a category you added that holds nothing.\n\nTwo categories cannot go. One the product supplied stays, because the wording it falls back to belongs to the product. One that still holds natures stays, and the answer says how many, because removing it would take them with it. Move them elsewhere first, or retire the category instead.\n\nBoth refusals bite today, since natures are filed under categories from the moment an account is created.\n\nA deletion is recoverable, so an accident is not the end of anything.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "lifeEventCategory",
                        "in": "path",
                        "required": true,
                        "description": "The id of the category. A path that is not a uuid answers 404 without a query being run.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Nothing. A supplied category, and one still holding a nature, each answer 422 naming that reason, and one belonging to somebody else answers 404."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/life-event-categories/{lifeEventCategory}/types": {
            "get": {
                "operationId": "life-event-categories-types",
                "tags": [
                    "Life event categories"
                ],
                "summary": "List the life event types of a category",
                "description": "List the natures filed under one category, in the order you arranged them.\n\nThis is the grouped reading the settings screen shows, one category at a time. Retired natures are listed with the rest, and so are the natures of a retired category, because the list says what is filed where rather than what is currently offered.\n\nThe natures are described exactly as the life event types endpoints describe them, so anything you read here can be changed there without asking for it again.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "lifeEventCategory",
                        "in": "path",
                        "required": true,
                        "description": "The id of the category. A path that is not a uuid answers 404 without a query being run.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to answer with.",
                        "schema": {
                            "type": "integer",
                            "default": 1
                        }
                    },
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "How many categories one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused.",
                        "schema": {
                            "type": "integer",
                            "default": 25
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of life event type objects, and how many there are in all. A category belonging to somebody else answers 404 rather than an empty list.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The natures on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One nature.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always life_event_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "life_event_category_id": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "format": "uuid",
                                                                "description": "The category the nature is filed under, which is the category you asked about."
                                                            },
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the nature is called, in the language you ask for while the product still supplies the wording."
                                                            },
                                                            "description": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "A sentence saying what the nature covers, or null when nobody wrote one."
                                                            },
                                                            "icon": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The glyph drawn beside the nature, or null."
                                                            },
                                                            "colour": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The tint the nature is drawn in, or null."
                                                            },
                                                            "position": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "Where the nature sits inside this category, counting from 1."
                                                            },
                                                            "is_system": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the product supplied the nature, which governs deletion and nothing else."
                                                            },
                                                            "is_active": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the nature is offered when a life event is recorded."
                                                            },
                                                            "updates_last_in_touch": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether a life event of this nature sets the Last in touch date of the contacts it is recorded with."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the nature was added, as a count of seconds since 1970."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds, or null."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "life_event_type",
                                            "id": "c3f9a8d1-4e62-4b07-9a35-6d180b2fc74e",
                                            "attributes": {
                                                "life_event_category_id": "5f8b3c21-9d07-4a64-8e12-7b0a4d6c3e95",
                                                "name": "Call",
                                                "description": null,
                                                "icon": "activity",
                                                "colour": null,
                                                "position": 1,
                                                "is_system": true,
                                                "is_active": true,
                                                "updates_last_in_touch": true,
                                                "created_at": 1756252800,
                                                "updated_at": 1756252800
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/life-event-types/c3f9a8d1-4e62-4b07-9a35-6d180b2fc74e"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "life-event-categories-types-query",
                "tags": [
                    "Life event categories"
                ],
                "summary": "List the life event types of a category",
                "description": "List the natures filed under one category, in the order you arranged them.\n\nThis is the grouped reading the settings screen shows, one category at a time. Retired natures are listed with the rest, and so are the natures of a retired category, because the list says what is filed where rather than what is currently offered.\n\nThe natures are described exactly as the life event types endpoints describe them, so anything you read here can be changed there without asking for it again.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "lifeEventCategory",
                        "in": "path",
                        "required": true,
                        "description": "The id of the category. A path that is not a uuid answers 404 without a query being run.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "page": {
                                        "type": "integer",
                                        "default": 1,
                                        "description": "Which page to answer with."
                                    },
                                    "per_page": {
                                        "type": "integer",
                                        "default": 25,
                                        "description": "How many categories one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "A page of life event type objects, and how many there are in all. A category belonging to somebody else answers 404 rather than an empty list.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The natures on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One nature.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always life_event_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "life_event_category_id": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "format": "uuid",
                                                                "description": "The category the nature is filed under, which is the category you asked about."
                                                            },
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the nature is called, in the language you ask for while the product still supplies the wording."
                                                            },
                                                            "description": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "A sentence saying what the nature covers, or null when nobody wrote one."
                                                            },
                                                            "icon": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The glyph drawn beside the nature, or null."
                                                            },
                                                            "colour": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The tint the nature is drawn in, or null."
                                                            },
                                                            "position": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "Where the nature sits inside this category, counting from 1."
                                                            },
                                                            "is_system": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the product supplied the nature, which governs deletion and nothing else."
                                                            },
                                                            "is_active": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the nature is offered when a life event is recorded."
                                                            },
                                                            "updates_last_in_touch": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether a life event of this nature sets the Last in touch date of the contacts it is recorded with."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the nature was added, as a count of seconds since 1970."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds, or null."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "life_event_type",
                                            "id": "c3f9a8d1-4e62-4b07-9a35-6d180b2fc74e",
                                            "attributes": {
                                                "life_event_category_id": "5f8b3c21-9d07-4a64-8e12-7b0a4d6c3e95",
                                                "name": "Call",
                                                "description": null,
                                                "icon": "activity",
                                                "colour": null,
                                                "position": 1,
                                                "is_system": true,
                                                "is_active": true,
                                                "updates_last_in_touch": true,
                                                "created_at": 1756252800,
                                                "updated_at": 1756252800
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/life-event-types/c3f9a8d1-4e62-4b07-9a35-6d180b2fc74e"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/life-event-categories/{lifeEventCategory}/activation": {
            "put": {
                "operationId": "life-event-categories-activation",
                "tags": [
                    "Life event categories"
                ],
                "summary": "Offer or retire a life event category",
                "description": "Say whether a category, and every nature under it, may still be chosen when a life event is recorded.\n\nRetiring a category takes it out of the choice offered when somebody records a life event. It is the answer wherever deletion is refused, and it works on a category the product supplied as readily as on your own.\n\nNothing already written is touched. Every life event keeps its nature and reads as it did, and the category keeps the place it had, so offering it again puts it back where it was rather than at the end.\n\nRetiring a category retires the choice of every nature under it, and offering it again brings them all back, each still holding whether it is offered in its own right.\n\nSend the state you want rather than asking for a toggle, so sending the same value twice confirms it instead of inverting it.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "lifeEventCategory",
                        "in": "path",
                        "required": true,
                        "description": "The id of the category. A path that is not a uuid answers 404 without a query being run.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "is_active": {
                                        "type": "boolean",
                                        "description": "True to offer the category again, false to retire it."
                                    }
                                },
                                "required": [
                                    "is_active"
                                ]
                            },
                            "example": {
                                "is_active": false
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The life event category object in the state you asked for.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The category.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always life_event_category. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the category is called. A category the product supplied reads in the language you ask for, until somebody renames it, after which their words stand in every language. Up to 255 characters, reduced to plain text, so no markup survives here."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the category sits in the settings, the pickers and the journal filters, counting from 1. Retired categories are numbered along with the rest, so one switched back on finds the place it had."
                                                        },
                                                        "is_system": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the product supplied the category with the account. It governs one thing and one thing only: a supplied category cannot be deleted. It may be renamed, moved and retired like any other."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the category and the natures under it are offered when a life event is recorded. False removes the whole category from that choice and touches nothing already written."
                                                        },
                                                        "life_event_type_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many life event natures are filed under the category, retired ones counted. It is what decides whether the category may be deleted."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the category was added, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "life_event_category",
                                        "id": "5f8b3c21-9d07-4a64-8e12-7b0a4d6c3e95",
                                        "attributes": {
                                            "name": "Relationships and family",
                                            "position": 1,
                                            "is_system": true,
                                            "is_active": true,
                                            "life_event_type_count": 0,
                                            "created_at": 1756252800,
                                            "updated_at": 1756252800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/life-event-categories/5f8b3c21-9d07-4a64-8e12-7b0a4d6c3e95"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/life-event-categories/{lifeEventCategory}/position": {
            "put": {
                "operationId": "life-event-categories-position",
                "tags": [
                    "Life event categories"
                ],
                "summary": "Move a life event category",
                "description": "Put a category somewhere else in the list, so the ones you reach for sit at the top.\n\nEvery category of your account is numbered from 1 again once the move is made, retired ones counted among them. A position past the end puts the category last rather than being refused.\n\nA category the product supplied may be moved like any other. Where a category sits changes the order it is read in, in the settings, the pickers and the journal filters, and changes nothing else.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "lifeEventCategory",
                        "in": "path",
                        "required": true,
                        "description": "The id of the category. A path that is not a uuid answers 404 without a query being run.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "position": {
                                        "type": "integer",
                                        "description": "Where the category should sit, counting from 1."
                                    }
                                },
                                "required": [
                                    "position"
                                ]
                            },
                            "example": {
                                "position": 1
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The life event category object in its new place.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The category.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always life_event_category. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the category is called. A category the product supplied reads in the language you ask for, until somebody renames it, after which their words stand in every language. Up to 255 characters, reduced to plain text, so no markup survives here."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the category sits in the settings, the pickers and the journal filters, counting from 1. Retired categories are numbered along with the rest, so one switched back on finds the place it had."
                                                        },
                                                        "is_system": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the product supplied the category with the account. It governs one thing and one thing only: a supplied category cannot be deleted. It may be renamed, moved and retired like any other."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the category and the natures under it are offered when a life event is recorded. False removes the whole category from that choice and touches nothing already written."
                                                        },
                                                        "life_event_type_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many life event natures are filed under the category, retired ones counted. It is what decides whether the category may be deleted."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the category was added, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "life_event_category",
                                        "id": "5f8b3c21-9d07-4a64-8e12-7b0a4d6c3e95",
                                        "attributes": {
                                            "name": "Relationships and family",
                                            "position": 1,
                                            "is_system": true,
                                            "is_active": true,
                                            "life_event_type_count": 0,
                                            "created_at": 1756252800,
                                            "updated_at": 1756252800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/life-event-categories/5f8b3c21-9d07-4a64-8e12-7b0a4d6c3e95"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/life-event-types": {
            "get": {
                "operationId": "life-event-types-index",
                "tags": [
                    "Life event types"
                ],
                "summary": "List life event types",
                "description": "List every nature your account can record a life event as, grouped the way the picker groups them.\n\nA nature is what a life event was: lunch, a phone call, a medical appointment, a concert. It carries a name, a sentence saying what it covers, a glyph, a tint, and the custom fields a life event of that nature asks for, which are read at their own address rather than here.\n\nThe list runs through the categories in the order you arranged them, and through the natures inside each category in the order you arranged those. Retired natures are listed with the rest, because one that is off is meant to be found again and switched back on.\n\nA nature the product supplied reads in the language you ask for. Once somebody renames it, their words stand in every language.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to answer with.",
                        "schema": {
                            "type": "integer",
                            "default": 1
                        }
                    },
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "How many natures one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused.",
                        "schema": {
                            "type": "integer",
                            "default": 25
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of life event type objects, and how many there are in all.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The natures on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One nature.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always life_event_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "life_event_category_id": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "format": "uuid",
                                                                "description": "The category the nature is filed under. Moving a nature to another category is an ordinary change, and the life events recorded with it are regrouped along with it."
                                                            },
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the nature is called. One the product supplied reads in the language you ask for, until somebody renames it, after which their words stand in every language. Up to 255 characters, reduced to plain text, so no markup survives here."
                                                            },
                                                            "description": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "A sentence saying what the nature covers, shown where somebody chooses one. Up to 255 characters, or null when nobody wrote one."
                                                            },
                                                            "icon": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The glyph drawn beside the nature, chosen from the catalogue the product ships, or null to read by name alone."
                                                            },
                                                            "colour": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The tint the nature is drawn in, chosen from the palette the product ships, or null to take the ordinary one."
                                                            },
                                                            "position": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "Where the nature sits inside its category, counting from 1. Retired natures are numbered along with the rest, so one switched back on finds the place it had."
                                                            },
                                                            "is_system": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the product supplied the nature with the account. It governs one thing and one thing only: a supplied nature cannot be deleted. It may be renamed, redrawn, moved and retired like any other."
                                                            },
                                                            "is_active": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the nature is offered when a life event is recorded. False takes it out of that choice and touches nothing already written."
                                                            },
                                                            "updates_last_in_touch": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether a life event of this nature sets last_interaction_at, the Last in touch date, on the contacts it is recorded with. True for a moment shared with them, such as a call or a meal, and false for news about one of them, such as a move."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the nature was added, as a count of seconds since 1970 rather than a written date."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "life_event_type",
                                            "id": "c3f9a8d1-4e62-4b07-9a35-6d180b2fc74e",
                                            "attributes": {
                                                "life_event_category_id": "5f8b3c21-9d07-4a64-8e12-7b0a4d6c3e95",
                                                "name": "Call",
                                                "description": null,
                                                "icon": "activity",
                                                "colour": null,
                                                "position": 1,
                                                "is_system": true,
                                                "is_active": true,
                                                "updates_last_in_touch": true,
                                                "created_at": 1756252800,
                                                "updated_at": 1756252800
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/life-event-types/c3f9a8d1-4e62-4b07-9a35-6d180b2fc74e"
                                            }
                                        },
                                        {
                                            "type": "life_event_type",
                                            "id": "8b2e5c70-1a94-4f38-b6d2-0e7c94a35f18",
                                            "attributes": {
                                                "life_event_category_id": "5f8b3c21-9d07-4a64-8e12-7b0a4d6c3e95",
                                                "name": "Board game night",
                                                "description": "An evening around a table with a box of cardboard.",
                                                "icon": "activity",
                                                "colour": "bg-sky-500",
                                                "position": 2,
                                                "is_system": false,
                                                "is_active": true,
                                                "updates_last_in_touch": true,
                                                "created_at": 1756339200,
                                                "updated_at": 1756425600
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/life-event-types/8b2e5c70-1a94-4f38-b6d2-0e7c94a35f18"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 2
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "life-event-types-index-query",
                "tags": [
                    "Life event types"
                ],
                "summary": "List life event types",
                "description": "List every nature your account can record a life event as, grouped the way the picker groups them.\n\nA nature is what a life event was: lunch, a phone call, a medical appointment, a concert. It carries a name, a sentence saying what it covers, a glyph, a tint, and the custom fields a life event of that nature asks for, which are read at their own address rather than here.\n\nThe list runs through the categories in the order you arranged them, and through the natures inside each category in the order you arranged those. Retired natures are listed with the rest, because one that is off is meant to be found again and switched back on.\n\nA nature the product supplied reads in the language you ask for. Once somebody renames it, their words stand in every language.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "page": {
                                        "type": "integer",
                                        "default": 1,
                                        "description": "Which page to answer with."
                                    },
                                    "per_page": {
                                        "type": "integer",
                                        "default": 25,
                                        "description": "How many natures one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "A page of life event type objects, and how many there are in all.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The natures on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One nature.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always life_event_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "life_event_category_id": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "format": "uuid",
                                                                "description": "The category the nature is filed under. Moving a nature to another category is an ordinary change, and the life events recorded with it are regrouped along with it."
                                                            },
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the nature is called. One the product supplied reads in the language you ask for, until somebody renames it, after which their words stand in every language. Up to 255 characters, reduced to plain text, so no markup survives here."
                                                            },
                                                            "description": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "A sentence saying what the nature covers, shown where somebody chooses one. Up to 255 characters, or null when nobody wrote one."
                                                            },
                                                            "icon": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The glyph drawn beside the nature, chosen from the catalogue the product ships, or null to read by name alone."
                                                            },
                                                            "colour": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The tint the nature is drawn in, chosen from the palette the product ships, or null to take the ordinary one."
                                                            },
                                                            "position": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "Where the nature sits inside its category, counting from 1. Retired natures are numbered along with the rest, so one switched back on finds the place it had."
                                                            },
                                                            "is_system": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the product supplied the nature with the account. It governs one thing and one thing only: a supplied nature cannot be deleted. It may be renamed, redrawn, moved and retired like any other."
                                                            },
                                                            "is_active": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the nature is offered when a life event is recorded. False takes it out of that choice and touches nothing already written."
                                                            },
                                                            "updates_last_in_touch": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether a life event of this nature sets last_interaction_at, the Last in touch date, on the contacts it is recorded with. True for a moment shared with them, such as a call or a meal, and false for news about one of them, such as a move."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the nature was added, as a count of seconds since 1970 rather than a written date."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "life_event_type",
                                            "id": "c3f9a8d1-4e62-4b07-9a35-6d180b2fc74e",
                                            "attributes": {
                                                "life_event_category_id": "5f8b3c21-9d07-4a64-8e12-7b0a4d6c3e95",
                                                "name": "Call",
                                                "description": null,
                                                "icon": "activity",
                                                "colour": null,
                                                "position": 1,
                                                "is_system": true,
                                                "is_active": true,
                                                "updates_last_in_touch": true,
                                                "created_at": 1756252800,
                                                "updated_at": 1756252800
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/life-event-types/c3f9a8d1-4e62-4b07-9a35-6d180b2fc74e"
                                            }
                                        },
                                        {
                                            "type": "life_event_type",
                                            "id": "8b2e5c70-1a94-4f38-b6d2-0e7c94a35f18",
                                            "attributes": {
                                                "life_event_category_id": "5f8b3c21-9d07-4a64-8e12-7b0a4d6c3e95",
                                                "name": "Board game night",
                                                "description": "An evening around a table with a box of cardboard.",
                                                "icon": "activity",
                                                "colour": "bg-sky-500",
                                                "position": 2,
                                                "is_system": false,
                                                "is_active": true,
                                                "updates_last_in_touch": true,
                                                "created_at": 1756339200,
                                                "updated_at": 1756425600
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/life-event-types/8b2e5c70-1a94-4f38-b6d2-0e7c94a35f18"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 2
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "post": {
                "operationId": "life-event-types-create",
                "tags": [
                    "Life event types"
                ],
                "summary": "Add a life event type",
                "description": "Add a nature of your own, when the ones the product supplies do not describe what you actually do.\n\nThe nature goes at the end of the category you file it under and is offered straight away. Retire it afterwards if you are preparing a vocabulary you do not want offered yet.\n\nIt starts with no custom fields, which is a perfectly ordinary state: a life event of a brand new nature can be recorded immediately, carrying nothing beyond what every life event carries. Give it fields at their own address when you want them.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "life_event_category_id": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "The category to file the nature under. A category belonging to somebody else answers 404."
                                    },
                                    "name": {
                                        "type": "string",
                                        "description": "What the nature is called. Up to 255 characters. Markup and surrounding blank space are stripped, and a name left with nothing in it is refused."
                                    },
                                    "description": {
                                        "type": "string",
                                        "description": "A sentence saying what the nature covers. Up to 255 characters, stripped the same way."
                                    },
                                    "icon": {
                                        "type": "string",
                                        "description": "The glyph drawn beside the nature, from the catalogue the product ships. Anything else is refused."
                                    },
                                    "colour": {
                                        "type": "string",
                                        "description": "The tint the nature is drawn in, from the palette the product ships. Anything else is refused."
                                    },
                                    "updates_last_in_touch": {
                                        "type": "boolean",
                                        "description": "Whether its life events set the Last in touch date of the contacts they are recorded with. Left out, it does."
                                    }
                                },
                                "required": [
                                    "life_event_category_id",
                                    "name"
                                ]
                            },
                            "example": {
                                "life_event_category_id": "5f8b3c21-9d07-4a64-8e12-7b0a4d6c3e95",
                                "name": "Board game night",
                                "description": "An evening around a table with a box of cardboard.",
                                "icon": "activity",
                                "colour": "bg-sky-500",
                                "updates_last_in_touch": true
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The life event type object that was added.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The nature.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always life_event_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "life_event_category_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The category the nature is filed under. Moving a nature to another category is an ordinary change, and the life events recorded with it are regrouped along with it."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the nature is called. One the product supplied reads in the language you ask for, until somebody renames it, after which their words stand in every language. Up to 255 characters, reduced to plain text, so no markup survives here."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "A sentence saying what the nature covers, shown where somebody chooses one. Up to 255 characters, or null when nobody wrote one."
                                                        },
                                                        "icon": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The glyph drawn beside the nature, chosen from the catalogue the product ships, or null to read by name alone."
                                                        },
                                                        "colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The tint the nature is drawn in, chosen from the palette the product ships, or null to take the ordinary one."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the nature sits inside its category, counting from 1. Retired natures are numbered along with the rest, so one switched back on finds the place it had."
                                                        },
                                                        "is_system": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the product supplied the nature with the account. It governs one thing and one thing only: a supplied nature cannot be deleted. It may be renamed, redrawn, moved and retired like any other."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the nature is offered when a life event is recorded. False takes it out of that choice and touches nothing already written."
                                                        },
                                                        "updates_last_in_touch": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether a life event of this nature sets last_interaction_at, the Last in touch date, on the contacts it is recorded with. True for a moment shared with them, such as a call or a meal, and false for news about one of them, such as a move."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the nature was added, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "life_event_type",
                                        "id": "8b2e5c70-1a94-4f38-b6d2-0e7c94a35f18",
                                        "attributes": {
                                            "life_event_category_id": "5f8b3c21-9d07-4a64-8e12-7b0a4d6c3e95",
                                            "name": "Board game night",
                                            "description": "An evening around a table with a box of cardboard.",
                                            "icon": "activity",
                                            "colour": "bg-sky-500",
                                            "position": 2,
                                            "is_system": false,
                                            "is_active": true,
                                            "updates_last_in_touch": true,
                                            "created_at": 1756339200,
                                            "updated_at": 1756425600
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/life-event-types/8b2e5c70-1a94-4f38-b6d2-0e7c94a35f18"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/life-event-types/{lifeEventType}": {
            "get": {
                "operationId": "life-event-types-show",
                "tags": [
                    "Life event types"
                ],
                "summary": "Get a life event type",
                "description": "Retrieve one nature: what it is called, what it covers, how it is drawn and where it sits.\n\nThe custom fields the nature asks for are not in here. They are read at their own endpoint, so listing a vocabulary does not make you carry every layout it holds.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "lifeEventType",
                        "in": "path",
                        "required": true,
                        "description": "The id of the nature. A path that is not a uuid answers 404 without a query being run.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A life event type object. A nature belonging to somebody else answers 404, which is also what a nature that never existed answers, and what a deleted one answers.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The nature.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always life_event_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "life_event_category_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The category the nature is filed under. Moving a nature to another category is an ordinary change, and the life events recorded with it are regrouped along with it."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the nature is called. One the product supplied reads in the language you ask for, until somebody renames it, after which their words stand in every language. Up to 255 characters, reduced to plain text, so no markup survives here."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "A sentence saying what the nature covers, shown where somebody chooses one. Up to 255 characters, or null when nobody wrote one."
                                                        },
                                                        "icon": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The glyph drawn beside the nature, chosen from the catalogue the product ships, or null to read by name alone."
                                                        },
                                                        "colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The tint the nature is drawn in, chosen from the palette the product ships, or null to take the ordinary one."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the nature sits inside its category, counting from 1. Retired natures are numbered along with the rest, so one switched back on finds the place it had."
                                                        },
                                                        "is_system": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the product supplied the nature with the account. It governs one thing and one thing only: a supplied nature cannot be deleted. It may be renamed, redrawn, moved and retired like any other."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the nature is offered when a life event is recorded. False takes it out of that choice and touches nothing already written."
                                                        },
                                                        "updates_last_in_touch": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether a life event of this nature sets last_interaction_at, the Last in touch date, on the contacts it is recorded with. True for a moment shared with them, such as a call or a meal, and false for news about one of them, such as a move."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the nature was added, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "life_event_type",
                                        "id": "8b2e5c70-1a94-4f38-b6d2-0e7c94a35f18",
                                        "attributes": {
                                            "life_event_category_id": "5f8b3c21-9d07-4a64-8e12-7b0a4d6c3e95",
                                            "name": "Board game night",
                                            "description": "An evening around a table with a box of cardboard.",
                                            "icon": "activity",
                                            "colour": "bg-sky-500",
                                            "position": 2,
                                            "is_system": false,
                                            "is_active": true,
                                            "updates_last_in_touch": true,
                                            "created_at": 1756339200,
                                            "updated_at": 1756425600
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/life-event-types/8b2e5c70-1a94-4f38-b6d2-0e7c94a35f18"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "life-event-types-show-query",
                "tags": [
                    "Life event types"
                ],
                "summary": "Get a life event type",
                "description": "Retrieve one nature: what it is called, what it covers, how it is drawn and where it sits.\n\nThe custom fields the nature asks for are not in here. They are read at their own endpoint, so listing a vocabulary does not make you carry every layout it holds.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "lifeEventType",
                        "in": "path",
                        "required": true,
                        "description": "The id of the nature. A path that is not a uuid answers 404 without a query being run.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A life event type object. A nature belonging to somebody else answers 404, which is also what a nature that never existed answers, and what a deleted one answers.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The nature.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always life_event_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "life_event_category_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The category the nature is filed under. Moving a nature to another category is an ordinary change, and the life events recorded with it are regrouped along with it."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the nature is called. One the product supplied reads in the language you ask for, until somebody renames it, after which their words stand in every language. Up to 255 characters, reduced to plain text, so no markup survives here."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "A sentence saying what the nature covers, shown where somebody chooses one. Up to 255 characters, or null when nobody wrote one."
                                                        },
                                                        "icon": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The glyph drawn beside the nature, chosen from the catalogue the product ships, or null to read by name alone."
                                                        },
                                                        "colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The tint the nature is drawn in, chosen from the palette the product ships, or null to take the ordinary one."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the nature sits inside its category, counting from 1. Retired natures are numbered along with the rest, so one switched back on finds the place it had."
                                                        },
                                                        "is_system": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the product supplied the nature with the account. It governs one thing and one thing only: a supplied nature cannot be deleted. It may be renamed, redrawn, moved and retired like any other."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the nature is offered when a life event is recorded. False takes it out of that choice and touches nothing already written."
                                                        },
                                                        "updates_last_in_touch": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether a life event of this nature sets last_interaction_at, the Last in touch date, on the contacts it is recorded with. True for a moment shared with them, such as a call or a meal, and false for news about one of them, such as a move."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the nature was added, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "life_event_type",
                                        "id": "8b2e5c70-1a94-4f38-b6d2-0e7c94a35f18",
                                        "attributes": {
                                            "life_event_category_id": "5f8b3c21-9d07-4a64-8e12-7b0a4d6c3e95",
                                            "name": "Board game night",
                                            "description": "An evening around a table with a box of cardboard.",
                                            "icon": "activity",
                                            "colour": "bg-sky-500",
                                            "position": 2,
                                            "is_system": false,
                                            "is_active": true,
                                            "updates_last_in_touch": true,
                                            "created_at": 1756339200,
                                            "updated_at": 1756425600
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/life-event-types/8b2e5c70-1a94-4f38-b6d2-0e7c94a35f18"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "put": {
                "operationId": "life-event-types-update",
                "tags": [
                    "Life event types"
                ],
                "summary": "Change a life event type",
                "description": "Change what a nature is called, what it covers, how it is drawn and which category it is filed under.\n\nA nature the product supplied is changed like any other. is_system stops a nature being deleted and stops nothing else, so a household that calls a phone call something else writes it here.\n\nMoving a nature to another category puts it last there, because the order inside a category is an order somebody chose and an arrival has no claim on a place in it.\n\nNothing a life event has recorded changes, since a life event names its nature rather than copying it. Renaming a nature renames it on every life event already recorded with it, which is the point.\n\nOnce you write your own words they stand in every language. The wording the product supplied reads in the language of whoever is looking, and renaming gives that up.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "lifeEventType",
                        "in": "path",
                        "required": true,
                        "description": "The id of the nature. A path that is not a uuid answers 404 without a query being run.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "life_event_category_id": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "The category to file the nature under. A category belonging to somebody else answers 404. It cannot be null."
                                    },
                                    "name": {
                                        "type": "string",
                                        "description": "What the nature is called. Up to 255 characters. Markup and surrounding blank space are stripped, and a name left with nothing in it is refused. It cannot be null."
                                    },
                                    "description": {
                                        "type": "string",
                                        "description": "A sentence saying what the nature covers. Up to 255 characters, stripped the same way. Null clears it."
                                    },
                                    "icon": {
                                        "type": "string",
                                        "description": "The glyph drawn beside the nature, from the catalogue the product ships. Anything else is refused."
                                    },
                                    "colour": {
                                        "type": "string",
                                        "description": "The tint the nature is drawn in, from the palette the product ships. Anything else is refused."
                                    },
                                    "updates_last_in_touch": {
                                        "type": "boolean",
                                        "description": "Whether its life events set the Last in touch date of the contacts they are recorded with. Left out, it stays as it is. A change works the date out again for everybody who took part in one, shortly after the answer."
                                    }
                                }
                            },
                            "example": {
                                "life_event_category_id": "5f8b3c21-9d07-4a64-8e12-7b0a4d6c3e95",
                                "name": "Board game night",
                                "description": "An evening around a table with a box of cardboard.",
                                "icon": "activity",
                                "colour": "bg-sky-500",
                                "updates_last_in_touch": false
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The life event type object as it now reads.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The nature.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always life_event_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "life_event_category_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The category the nature is filed under. Moving a nature to another category is an ordinary change, and the life events recorded with it are regrouped along with it."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the nature is called. One the product supplied reads in the language you ask for, until somebody renames it, after which their words stand in every language. Up to 255 characters, reduced to plain text, so no markup survives here."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "A sentence saying what the nature covers, shown where somebody chooses one. Up to 255 characters, or null when nobody wrote one."
                                                        },
                                                        "icon": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The glyph drawn beside the nature, chosen from the catalogue the product ships, or null to read by name alone."
                                                        },
                                                        "colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The tint the nature is drawn in, chosen from the palette the product ships, or null to take the ordinary one."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the nature sits inside its category, counting from 1. Retired natures are numbered along with the rest, so one switched back on finds the place it had."
                                                        },
                                                        "is_system": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the product supplied the nature with the account. It governs one thing and one thing only: a supplied nature cannot be deleted. It may be renamed, redrawn, moved and retired like any other."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the nature is offered when a life event is recorded. False takes it out of that choice and touches nothing already written."
                                                        },
                                                        "updates_last_in_touch": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether a life event of this nature sets last_interaction_at, the Last in touch date, on the contacts it is recorded with. True for a moment shared with them, such as a call or a meal, and false for news about one of them, such as a move."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the nature was added, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "life_event_type",
                                        "id": "8b2e5c70-1a94-4f38-b6d2-0e7c94a35f18",
                                        "attributes": {
                                            "life_event_category_id": "5f8b3c21-9d07-4a64-8e12-7b0a4d6c3e95",
                                            "name": "Board game night",
                                            "description": "An evening around a table with a box of cardboard.",
                                            "icon": "activity",
                                            "colour": "bg-sky-500",
                                            "position": 2,
                                            "is_system": false,
                                            "is_active": true,
                                            "updates_last_in_touch": true,
                                            "created_at": 1756339200,
                                            "updated_at": 1756425600
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/life-event-types/8b2e5c70-1a94-4f38-b6d2-0e7c94a35f18"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "delete": {
                "operationId": "life-event-types-destroy",
                "tags": [
                    "Life event types"
                ],
                "summary": "Delete a life event type",
                "description": "Remove a nature you added.\n\nA nature the product supplied stays, because the wording it falls back to belongs to the product. Retire it instead: it leaves the choice offered when a life event is recorded, and everything already written keeps reading as it did.\n\nA deletion is recoverable, so an accident is not the end of anything. The custom fields the nature asked for are deliberately left where they are, so a restored nature comes back asking for what it asked for.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "lifeEventType",
                        "in": "path",
                        "required": true,
                        "description": "The id of the nature. A path that is not a uuid answers 404 without a query being run.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Nothing. A nature the product supplied answers 422 naming that reason, and one belonging to somebody else answers 404."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/life-event-types/{lifeEventType}/activation": {
            "put": {
                "operationId": "life-event-types-activation",
                "tags": [
                    "Life event types"
                ],
                "summary": "Offer or retire a life event type",
                "description": "Say whether a nature may still be chosen when a life event is recorded.\n\nRetiring a nature takes it out of the choice offered when somebody records a life event. It is the answer wherever deletion is refused, and it works on a nature the product supplied as readily as on your own.\n\nNothing already written is touched. Every life event keeps its nature, its drawing and its custom fields, and the nature keeps the place it had, so offering it again puts it back where it was rather than at the end.\n\nSend the state you want rather than asking for a toggle, so sending the same value twice confirms it instead of inverting it.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "lifeEventType",
                        "in": "path",
                        "required": true,
                        "description": "The id of the nature. A path that is not a uuid answers 404 without a query being run.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "is_active": {
                                        "type": "boolean",
                                        "description": "True to offer the nature again, false to retire it."
                                    }
                                },
                                "required": [
                                    "is_active"
                                ]
                            },
                            "example": {
                                "is_active": false
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The life event type object in the state you asked for.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The nature.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always life_event_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "life_event_category_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The category the nature is filed under. Moving a nature to another category is an ordinary change, and the life events recorded with it are regrouped along with it."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the nature is called. One the product supplied reads in the language you ask for, until somebody renames it, after which their words stand in every language. Up to 255 characters, reduced to plain text, so no markup survives here."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "A sentence saying what the nature covers, shown where somebody chooses one. Up to 255 characters, or null when nobody wrote one."
                                                        },
                                                        "icon": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The glyph drawn beside the nature, chosen from the catalogue the product ships, or null to read by name alone."
                                                        },
                                                        "colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The tint the nature is drawn in, chosen from the palette the product ships, or null to take the ordinary one."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the nature sits inside its category, counting from 1. Retired natures are numbered along with the rest, so one switched back on finds the place it had."
                                                        },
                                                        "is_system": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the product supplied the nature with the account. It governs one thing and one thing only: a supplied nature cannot be deleted. It may be renamed, redrawn, moved and retired like any other."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the nature is offered when a life event is recorded. False takes it out of that choice and touches nothing already written."
                                                        },
                                                        "updates_last_in_touch": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether a life event of this nature sets last_interaction_at, the Last in touch date, on the contacts it is recorded with. True for a moment shared with them, such as a call or a meal, and false for news about one of them, such as a move."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the nature was added, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "life_event_type",
                                        "id": "8b2e5c70-1a94-4f38-b6d2-0e7c94a35f18",
                                        "attributes": {
                                            "life_event_category_id": "5f8b3c21-9d07-4a64-8e12-7b0a4d6c3e95",
                                            "name": "Board game night",
                                            "description": "An evening around a table with a box of cardboard.",
                                            "icon": "activity",
                                            "colour": "bg-sky-500",
                                            "position": 2,
                                            "is_system": false,
                                            "is_active": true,
                                            "updates_last_in_touch": true,
                                            "created_at": 1756339200,
                                            "updated_at": 1756425600
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/life-event-types/8b2e5c70-1a94-4f38-b6d2-0e7c94a35f18"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/life-event-types/{lifeEventType}/position": {
            "put": {
                "operationId": "life-event-types-position",
                "tags": [
                    "Life event types"
                ],
                "summary": "Move a life event type",
                "description": "Put a nature somewhere else inside the category it is filed under, so the ones you reach for sit at the top.\n\nEvery nature of that one category is numbered from 1 again once the move is made, retired ones counted among them. A position past the end puts the nature last rather than being refused.\n\nMoving a nature to another category is not this: it is an ordinary change, and it puts the nature last where it arrives.\n\nA nature the product supplied may be moved like any other. Where a nature sits changes the order it is read in and changes nothing else.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "lifeEventType",
                        "in": "path",
                        "required": true,
                        "description": "The id of the nature. A path that is not a uuid answers 404 without a query being run.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "position": {
                                        "type": "integer",
                                        "description": "Where the nature should sit inside its category, counting from 1."
                                    }
                                },
                                "required": [
                                    "position"
                                ]
                            },
                            "example": {
                                "position": 1
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The life event type object where you put it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The nature.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always life_event_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "life_event_category_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The category the nature is filed under. Moving a nature to another category is an ordinary change, and the life events recorded with it are regrouped along with it."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the nature is called. One the product supplied reads in the language you ask for, until somebody renames it, after which their words stand in every language. Up to 255 characters, reduced to plain text, so no markup survives here."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "A sentence saying what the nature covers, shown where somebody chooses one. Up to 255 characters, or null when nobody wrote one."
                                                        },
                                                        "icon": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The glyph drawn beside the nature, chosen from the catalogue the product ships, or null to read by name alone."
                                                        },
                                                        "colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The tint the nature is drawn in, chosen from the palette the product ships, or null to take the ordinary one."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the nature sits inside its category, counting from 1. Retired natures are numbered along with the rest, so one switched back on finds the place it had."
                                                        },
                                                        "is_system": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the product supplied the nature with the account. It governs one thing and one thing only: a supplied nature cannot be deleted. It may be renamed, redrawn, moved and retired like any other."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the nature is offered when a life event is recorded. False takes it out of that choice and touches nothing already written."
                                                        },
                                                        "updates_last_in_touch": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether a life event of this nature sets last_interaction_at, the Last in touch date, on the contacts it is recorded with. True for a moment shared with them, such as a call or a meal, and false for news about one of them, such as a move."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the nature was added, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "life_event_type",
                                        "id": "8b2e5c70-1a94-4f38-b6d2-0e7c94a35f18",
                                        "attributes": {
                                            "life_event_category_id": "5f8b3c21-9d07-4a64-8e12-7b0a4d6c3e95",
                                            "name": "Board game night",
                                            "description": "An evening around a table with a box of cardboard.",
                                            "icon": "activity",
                                            "colour": "bg-sky-500",
                                            "position": 2,
                                            "is_system": false,
                                            "is_active": true,
                                            "updates_last_in_touch": true,
                                            "created_at": 1756339200,
                                            "updated_at": 1756425600
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/life-event-types/8b2e5c70-1a94-4f38-b6d2-0e7c94a35f18"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/life-event-types/{lifeEventType}/fields": {
            "get": {
                "operationId": "life-event-types-fields",
                "tags": [
                    "Life event types"
                ],
                "summary": "Read the custom fields of a life event type",
                "description": "Read what a life event of one nature is asked for: the groups, and the fields in each.\n\nA group is a heading drawn above its fields. The fields nobody grouped are a group too, placed first with its heading not drawn, because a field belongs to a group and to nothing else.\n\nA nature nobody has given fields to answers an empty list rather than 404. That is the state every nature starts in.\n\nEach field carries the key it is known by. Send that key back when you write the layout and the field is kept rather than replaced, which is what stops the values already recorded against it being orphaned.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "lifeEventType",
                        "in": "path",
                        "required": true,
                        "description": "The id of the nature. A path that is not a uuid answers 404 without a query being run.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The groups of the layout, each with its fields. A nature belonging to somebody else answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The groups the layout is made of, in the order they are shown. An empty list when the nature asks for nothing.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One group.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always structure_version_section. It names the kind of record, so a caller holding several kinds can tell them apart."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of the group, as a string even when it reads as a number."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the group holds.",
                                                        "properties": {
                                                            "position": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "Where the group sits in the layout, counting from 1. The fields nobody grouped are a group too, and they come first."
                                                            },
                                                            "title": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the group is headed. The fields nobody grouped answer with a heading that is not drawn."
                                                            },
                                                            "title_override": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The heading chosen for this group alone, or null when the underlying name is used."
                                                            },
                                                            "section_id": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The id of the reusable block behind the group. It belongs to the engine that stores the layout and a caller rarely needs it."
                                                            },
                                                            "section_name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What that block is called in the library it lives in."
                                                            },
                                                            "section_version_number": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "Which frozen version of the block is placed here. This is what stops a change reaching a life event already recorded."
                                                            },
                                                            "section_version_status": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "One of draft, published or retired, for the block rather than for the nature."
                                                            },
                                                            "is_collapsed_by_default": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the group starts folded shut when somebody opens the life event."
                                                            },
                                                            "fields": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "What the group collects, in the order it is shown.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One field.",
                                                                    "properties": {
                                                                        "type": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "Always field. It names the kind of record, so a caller holding several kinds can tell them apart."
                                                                        },
                                                                        "id": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The id of the field, as a string even when it reads as a number."
                                                                        },
                                                                        "attributes": {
                                                                            "type": [
                                                                                "object",
                                                                                "null"
                                                                            ],
                                                                            "description": "Everything the field holds.",
                                                                            "properties": {
                                                                                "key": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "How the field is named in an import or an export, settled when the field is added. Send it back to keep a field rather than replace it."
                                                                                },
                                                                                "type": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "What kind of thing the field holds: one of text, textarea, number, boolean, url, email, phone, select, multiselect, radio, date, recurring_date, duration (a whole number of minutes), relation, file, image, avatar, address, repeater, divider, heading or help. The last three carry no value and are there to lay the form out."
                                                                                },
                                                                                "label": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "What the field is called on the form."
                                                                                },
                                                                                "help_text": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "A sentence shown under the field, or null when there is none."
                                                                                },
                                                                                "placeholder": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "What the empty box shows as an example, or null."
                                                                                },
                                                                                "position": {
                                                                                    "type": [
                                                                                        "integer",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Where the field sits in its group, counting from 1."
                                                                                },
                                                                                "is_required": {
                                                                                    "type": [
                                                                                        "boolean",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Whether the life event refuses to save without it."
                                                                                },
                                                                                "is_sensitive": {
                                                                                    "type": [
                                                                                        "boolean",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Whether the value is hidden until somebody asks to see it."
                                                                                },
                                                                                "is_highlighted": {
                                                                                    "type": [
                                                                                        "boolean",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Whether the value is repeated at the top of the life event."
                                                                                },
                                                                                "is_unique": {
                                                                                    "type": [
                                                                                        "boolean",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Whether two life events of this nature may hold the same value."
                                                                                },
                                                                                "is_identifying": {
                                                                                    "type": [
                                                                                        "boolean",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Whether two life events sharing this value are likely the same life event."
                                                                                },
                                                                                "is_repeatable": {
                                                                                    "type": [
                                                                                        "boolean",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Whether the field holds several values rather than one. It follows from the type."
                                                                                },
                                                                                "repeat_min": {
                                                                                    "type": [
                                                                                        "integer",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "The fewest repetitions allowed, or null when there is no floor."
                                                                                },
                                                                                "repeat_max": {
                                                                                    "type": [
                                                                                        "integer",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "The most repetitions allowed, or null when there is no ceiling."
                                                                                },
                                                                                "repetition_order": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "How several values are ordered against each other, or null when the field holds one."
                                                                                },
                                                                                "options": {
                                                                                    "type": [
                                                                                        "object",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Settings belonging to this kind of field alone, or null. What it holds depends on the type."
                                                                                },
                                                                                "validation": {
                                                                                    "type": [
                                                                                        "object",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Extra rules a value has to satisfy, or null."
                                                                                },
                                                                                "default_value": {
                                                                                    "type": [
                                                                                        "object",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "What the field starts filled with, or null."
                                                                                },
                                                                                "relation_target": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "What a relation field points at, or null when the field is not a relation."
                                                                                },
                                                                                "created_at": {
                                                                                    "type": [
                                                                                        "integer",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "When the field was added, as a count of seconds since 1970."
                                                                                },
                                                                                "updated_at": {
                                                                                    "type": [
                                                                                        "integer",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "When it last changed, as a count of seconds, or null."
                                                                                }
                                                                            }
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "structure_version_section",
                                            "id": "41",
                                            "attributes": {
                                                "position": 1,
                                                "title": "Where",
                                                "title_override": "Where",
                                                "section_id": "ec0a7b19-5d38-4c72-9a61-2f80d4b63e57",
                                                "section_name": "Where",
                                                "section_version_number": 1,
                                                "section_version_status": "published",
                                                "is_collapsed_by_default": false,
                                                "fields": [
                                                    {
                                                        "type": "field",
                                                        "id": "88",
                                                        "attributes": {
                                                            "key": "venue",
                                                            "type": "text",
                                                            "label": "Venue",
                                                            "help_text": null,
                                                            "placeholder": null,
                                                            "position": 1,
                                                            "is_required": true,
                                                            "is_sensitive": false,
                                                            "is_highlighted": false,
                                                            "is_unique": false,
                                                            "is_identifying": false,
                                                            "is_repeatable": false,
                                                            "repeat_min": null,
                                                            "repeat_max": null,
                                                            "repetition_order": null,
                                                            "options": null,
                                                            "validation": null,
                                                            "default_value": null,
                                                            "relation_target": null,
                                                            "created_at": 1756339200,
                                                            "updated_at": 1756339200
                                                        }
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "life-event-types-fields-query",
                "tags": [
                    "Life event types"
                ],
                "summary": "Read the custom fields of a life event type",
                "description": "Read what a life event of one nature is asked for: the groups, and the fields in each.\n\nA group is a heading drawn above its fields. The fields nobody grouped are a group too, placed first with its heading not drawn, because a field belongs to a group and to nothing else.\n\nA nature nobody has given fields to answers an empty list rather than 404. That is the state every nature starts in.\n\nEach field carries the key it is known by. Send that key back when you write the layout and the field is kept rather than replaced, which is what stops the values already recorded against it being orphaned.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "lifeEventType",
                        "in": "path",
                        "required": true,
                        "description": "The id of the nature. A path that is not a uuid answers 404 without a query being run.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The groups of the layout, each with its fields. A nature belonging to somebody else answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The groups the layout is made of, in the order they are shown. An empty list when the nature asks for nothing.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One group.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always structure_version_section. It names the kind of record, so a caller holding several kinds can tell them apart."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of the group, as a string even when it reads as a number."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the group holds.",
                                                        "properties": {
                                                            "position": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "Where the group sits in the layout, counting from 1. The fields nobody grouped are a group too, and they come first."
                                                            },
                                                            "title": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the group is headed. The fields nobody grouped answer with a heading that is not drawn."
                                                            },
                                                            "title_override": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The heading chosen for this group alone, or null when the underlying name is used."
                                                            },
                                                            "section_id": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The id of the reusable block behind the group. It belongs to the engine that stores the layout and a caller rarely needs it."
                                                            },
                                                            "section_name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What that block is called in the library it lives in."
                                                            },
                                                            "section_version_number": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "Which frozen version of the block is placed here. This is what stops a change reaching a life event already recorded."
                                                            },
                                                            "section_version_status": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "One of draft, published or retired, for the block rather than for the nature."
                                                            },
                                                            "is_collapsed_by_default": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the group starts folded shut when somebody opens the life event."
                                                            },
                                                            "fields": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "What the group collects, in the order it is shown.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One field.",
                                                                    "properties": {
                                                                        "type": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "Always field. It names the kind of record, so a caller holding several kinds can tell them apart."
                                                                        },
                                                                        "id": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The id of the field, as a string even when it reads as a number."
                                                                        },
                                                                        "attributes": {
                                                                            "type": [
                                                                                "object",
                                                                                "null"
                                                                            ],
                                                                            "description": "Everything the field holds.",
                                                                            "properties": {
                                                                                "key": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "How the field is named in an import or an export, settled when the field is added. Send it back to keep a field rather than replace it."
                                                                                },
                                                                                "type": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "What kind of thing the field holds: one of text, textarea, number, boolean, url, email, phone, select, multiselect, radio, date, recurring_date, duration (a whole number of minutes), relation, file, image, avatar, address, repeater, divider, heading or help. The last three carry no value and are there to lay the form out."
                                                                                },
                                                                                "label": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "What the field is called on the form."
                                                                                },
                                                                                "help_text": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "A sentence shown under the field, or null when there is none."
                                                                                },
                                                                                "placeholder": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "What the empty box shows as an example, or null."
                                                                                },
                                                                                "position": {
                                                                                    "type": [
                                                                                        "integer",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Where the field sits in its group, counting from 1."
                                                                                },
                                                                                "is_required": {
                                                                                    "type": [
                                                                                        "boolean",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Whether the life event refuses to save without it."
                                                                                },
                                                                                "is_sensitive": {
                                                                                    "type": [
                                                                                        "boolean",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Whether the value is hidden until somebody asks to see it."
                                                                                },
                                                                                "is_highlighted": {
                                                                                    "type": [
                                                                                        "boolean",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Whether the value is repeated at the top of the life event."
                                                                                },
                                                                                "is_unique": {
                                                                                    "type": [
                                                                                        "boolean",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Whether two life events of this nature may hold the same value."
                                                                                },
                                                                                "is_identifying": {
                                                                                    "type": [
                                                                                        "boolean",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Whether two life events sharing this value are likely the same life event."
                                                                                },
                                                                                "is_repeatable": {
                                                                                    "type": [
                                                                                        "boolean",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Whether the field holds several values rather than one. It follows from the type."
                                                                                },
                                                                                "repeat_min": {
                                                                                    "type": [
                                                                                        "integer",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "The fewest repetitions allowed, or null when there is no floor."
                                                                                },
                                                                                "repeat_max": {
                                                                                    "type": [
                                                                                        "integer",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "The most repetitions allowed, or null when there is no ceiling."
                                                                                },
                                                                                "repetition_order": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "How several values are ordered against each other, or null when the field holds one."
                                                                                },
                                                                                "options": {
                                                                                    "type": [
                                                                                        "object",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Settings belonging to this kind of field alone, or null. What it holds depends on the type."
                                                                                },
                                                                                "validation": {
                                                                                    "type": [
                                                                                        "object",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Extra rules a value has to satisfy, or null."
                                                                                },
                                                                                "default_value": {
                                                                                    "type": [
                                                                                        "object",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "What the field starts filled with, or null."
                                                                                },
                                                                                "relation_target": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "What a relation field points at, or null when the field is not a relation."
                                                                                },
                                                                                "created_at": {
                                                                                    "type": [
                                                                                        "integer",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "When the field was added, as a count of seconds since 1970."
                                                                                },
                                                                                "updated_at": {
                                                                                    "type": [
                                                                                        "integer",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "When it last changed, as a count of seconds, or null."
                                                                                }
                                                                            }
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "structure_version_section",
                                            "id": "41",
                                            "attributes": {
                                                "position": 1,
                                                "title": "Where",
                                                "title_override": "Where",
                                                "section_id": "ec0a7b19-5d38-4c72-9a61-2f80d4b63e57",
                                                "section_name": "Where",
                                                "section_version_number": 1,
                                                "section_version_status": "published",
                                                "is_collapsed_by_default": false,
                                                "fields": [
                                                    {
                                                        "type": "field",
                                                        "id": "88",
                                                        "attributes": {
                                                            "key": "venue",
                                                            "type": "text",
                                                            "label": "Venue",
                                                            "help_text": null,
                                                            "placeholder": null,
                                                            "position": 1,
                                                            "is_required": true,
                                                            "is_sensitive": false,
                                                            "is_highlighted": false,
                                                            "is_unique": false,
                                                            "is_identifying": false,
                                                            "is_repeatable": false,
                                                            "repeat_min": null,
                                                            "repeat_max": null,
                                                            "repetition_order": null,
                                                            "options": null,
                                                            "validation": null,
                                                            "default_value": null,
                                                            "relation_target": null,
                                                            "created_at": 1756339200,
                                                            "updated_at": 1756339200
                                                        }
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "put": {
                "operationId": "life-event-types-fields-update",
                "tags": [
                    "Life event types"
                ],
                "summary": "Write the custom fields of a life event type",
                "description": "Send the layout a life event of this nature should ask for.\n\nThis takes the finished layout rather than one change at a time, because that is the one gesture the product has for it. The layout is two lists, groups and fields, each sent whole. A list left out of the body keeps what is stored. A list sent replaces what is stored, so anything left out of it is gone.\n\nA field is matched to the one already there by its key. Send a field back with its key to keep it, leave the key out to add a field, and leave a field out altogether to take it away. Changing what kind of field it is, or what a relation points at, writes the field again in place under the same key.\n\nA group is matched by the placement_id you read it with. Leave that out to add a group, and leave a group out to take it away, which files its fields under no group rather than deleting them.\n\nEvery save publishes a new frozen version of the layout beside the old one. A life event already recorded names the version it was written on and never follows, so it keeps the fields and the values it was written with. This is the rule that makes the layout safe to change.\n\nA kind of field the product does not offer, and a group without a name, are both refused, and the layout already there is left exactly as it was.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "lifeEventType",
                        "in": "path",
                        "required": true,
                        "description": "The id of the nature. A path that is not a uuid answers 404 without a query being run.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "groups": {
                                        "type": "array",
                                        "description": "The groups of the layout, in the order you want them drawn.",
                                        "items": {
                                            "type": "object",
                                            "properties": {
                                                "placement_id": {
                                                    "type": "integer",
                                                    "description": "The id you read the group with, to keep it rather than replace it. Leave it out for a new group."
                                                },
                                                "name": {
                                                    "type": "string",
                                                    "description": "What the group is headed. Up to 255 characters, and a group without one is refused."
                                                },
                                                "fields": {
                                                    "type": "array",
                                                    "description": "The fields in that group, in the order you want them asked for. Each is shaped like an entry of the top level fields list."
                                                }
                                            },
                                            "required": [
                                                "name"
                                            ]
                                        }
                                    },
                                    "fields": {
                                        "type": "array",
                                        "description": "The fields that belong to no group. They are asked for first, under no heading.",
                                        "items": {
                                            "type": "object",
                                            "properties": {
                                                "key": {
                                                    "type": "string",
                                                    "description": "The key you read the field with, to keep it rather than replace it. Leave it out for a new field. Up to 64 characters."
                                                },
                                                "label": {
                                                    "type": "string",
                                                    "description": "What the field is called on the form. Up to 255 characters."
                                                },
                                                "type": {
                                                    "type": "string",
                                                    "description": "What kind of thing the field holds, from the list the read answers with. Anything else is refused."
                                                },
                                                "is_required": {
                                                    "type": "boolean",
                                                    "description": "Whether the life event refuses to save without it."
                                                },
                                                "help_text": {
                                                    "type": "string",
                                                    "description": "A sentence shown under the field. Up to 255 characters."
                                                },
                                                "settings": {
                                                    "type": "object",
                                                    "description": "Settings belonging to that kind of field alone, such as max_length on a text field or decimals on a number."
                                                },
                                                "choices": {
                                                    "type": "array",
                                                    "description": "What a select, multiselect or radio field offers, in order. Blank entries are dropped."
                                                }
                                            },
                                            "required": [
                                                "label",
                                                "type"
                                            ]
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The layout as it now stands, read back exactly as the read answers it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The groups the layout is made of, in the order they are shown. An empty list when the nature asks for nothing.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One group.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always structure_version_section. It names the kind of record, so a caller holding several kinds can tell them apart."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of the group, as a string even when it reads as a number."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the group holds.",
                                                        "properties": {
                                                            "position": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "Where the group sits in the layout, counting from 1. The fields nobody grouped are a group too, and they come first."
                                                            },
                                                            "title": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the group is headed. The fields nobody grouped answer with a heading that is not drawn."
                                                            },
                                                            "title_override": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The heading chosen for this group alone, or null when the underlying name is used."
                                                            },
                                                            "section_id": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The id of the reusable block behind the group. It belongs to the engine that stores the layout and a caller rarely needs it."
                                                            },
                                                            "section_name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What that block is called in the library it lives in."
                                                            },
                                                            "section_version_number": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "Which frozen version of the block is placed here. This is what stops a change reaching a life event already recorded."
                                                            },
                                                            "section_version_status": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "One of draft, published or retired, for the block rather than for the nature."
                                                            },
                                                            "is_collapsed_by_default": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the group starts folded shut when somebody opens the life event."
                                                            },
                                                            "fields": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "What the group collects, in the order it is shown.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One field.",
                                                                    "properties": {
                                                                        "type": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "Always field. It names the kind of record, so a caller holding several kinds can tell them apart."
                                                                        },
                                                                        "id": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The id of the field, as a string even when it reads as a number."
                                                                        },
                                                                        "attributes": {
                                                                            "type": [
                                                                                "object",
                                                                                "null"
                                                                            ],
                                                                            "description": "Everything the field holds.",
                                                                            "properties": {
                                                                                "key": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "How the field is named in an import or an export, settled when the field is added. Send it back to keep a field rather than replace it."
                                                                                },
                                                                                "type": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "What kind of thing the field holds: one of text, textarea, number, boolean, url, email, phone, select, multiselect, radio, date, recurring_date, duration (a whole number of minutes), relation, file, image, avatar, address, repeater, divider, heading or help. The last three carry no value and are there to lay the form out."
                                                                                },
                                                                                "label": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "What the field is called on the form."
                                                                                },
                                                                                "help_text": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "A sentence shown under the field, or null when there is none."
                                                                                },
                                                                                "placeholder": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "What the empty box shows as an example, or null."
                                                                                },
                                                                                "position": {
                                                                                    "type": [
                                                                                        "integer",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Where the field sits in its group, counting from 1."
                                                                                },
                                                                                "is_required": {
                                                                                    "type": [
                                                                                        "boolean",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Whether the life event refuses to save without it."
                                                                                },
                                                                                "is_sensitive": {
                                                                                    "type": [
                                                                                        "boolean",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Whether the value is hidden until somebody asks to see it."
                                                                                },
                                                                                "is_highlighted": {
                                                                                    "type": [
                                                                                        "boolean",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Whether the value is repeated at the top of the life event."
                                                                                },
                                                                                "is_unique": {
                                                                                    "type": [
                                                                                        "boolean",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Whether two life events of this nature may hold the same value."
                                                                                },
                                                                                "is_identifying": {
                                                                                    "type": [
                                                                                        "boolean",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Whether two life events sharing this value are likely the same life event."
                                                                                },
                                                                                "is_repeatable": {
                                                                                    "type": [
                                                                                        "boolean",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Whether the field holds several values rather than one. It follows from the type."
                                                                                },
                                                                                "repeat_min": {
                                                                                    "type": [
                                                                                        "integer",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "The fewest repetitions allowed, or null when there is no floor."
                                                                                },
                                                                                "repeat_max": {
                                                                                    "type": [
                                                                                        "integer",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "The most repetitions allowed, or null when there is no ceiling."
                                                                                },
                                                                                "repetition_order": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "How several values are ordered against each other, or null when the field holds one."
                                                                                },
                                                                                "options": {
                                                                                    "type": [
                                                                                        "object",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Settings belonging to this kind of field alone, or null. What it holds depends on the type."
                                                                                },
                                                                                "validation": {
                                                                                    "type": [
                                                                                        "object",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Extra rules a value has to satisfy, or null."
                                                                                },
                                                                                "default_value": {
                                                                                    "type": [
                                                                                        "object",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "What the field starts filled with, or null."
                                                                                },
                                                                                "relation_target": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "What a relation field points at, or null when the field is not a relation."
                                                                                },
                                                                                "created_at": {
                                                                                    "type": [
                                                                                        "integer",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "When the field was added, as a count of seconds since 1970."
                                                                                },
                                                                                "updated_at": {
                                                                                    "type": [
                                                                                        "integer",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "When it last changed, as a count of seconds, or null."
                                                                                }
                                                                            }
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "structure_version_section",
                                            "id": "41",
                                            "attributes": {
                                                "position": 1,
                                                "title": "Where",
                                                "title_override": "Where",
                                                "section_id": "ec0a7b19-5d38-4c72-9a61-2f80d4b63e57",
                                                "section_name": "Where",
                                                "section_version_number": 1,
                                                "section_version_status": "published",
                                                "is_collapsed_by_default": false,
                                                "fields": [
                                                    {
                                                        "type": "field",
                                                        "id": "88",
                                                        "attributes": {
                                                            "key": "venue",
                                                            "type": "text",
                                                            "label": "Venue",
                                                            "help_text": null,
                                                            "placeholder": null,
                                                            "position": 1,
                                                            "is_required": true,
                                                            "is_sensitive": false,
                                                            "is_highlighted": false,
                                                            "is_unique": false,
                                                            "is_identifying": false,
                                                            "is_repeatable": false,
                                                            "repeat_min": null,
                                                            "repeat_max": null,
                                                            "repetition_order": null,
                                                            "options": null,
                                                            "validation": null,
                                                            "default_value": null,
                                                            "relation_target": null,
                                                            "created_at": 1756339200,
                                                            "updated_at": 1756339200
                                                        }
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/contacts/{contact}/reminders": {
            "get": {
                "operationId": "reminders-index",
                "tags": [
                    "Reminders"
                ],
                "summary": "List a contact's reminders",
                "description": "List every reminder about one contact, the ones written by hand and the ones reading a date on their page.\n\nA reminder is told on its day, once on each channel you switched on, and never again. Nothing is sent ahead of the day.\n\nDeleted reminders are left out. The answers given to their dates stay, and are read from the dates endpoint.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the contact lives in, named either by the readable name it reports as slug or by its id.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "contact",
                        "in": "path",
                        "required": true,
                        "description": "The contact the reminders are about, named either by its slug or by its id. A contact addressed through the wrong vault answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to answer with.",
                        "schema": {
                            "type": "integer",
                            "default": 1
                        }
                    },
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "How many records one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused.",
                        "schema": {
                            "type": "integer",
                            "default": 25
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of reminder objects, and how many there are in all.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The reminders on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One reminder.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always reminder. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the reminder says when it comes due."
                                                            },
                                                            "source": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Where its date comes from: manual when somebody wrote the reminder with a date of its own, field_value when it reads a date on the contact, such as a birthday."
                                                            },
                                                            "starts_on": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The first date of a manual reminder, written as a year, a month and a day. Null for a reminder that reads a date on the contact."
                                                            },
                                                            "field": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The date on the contact the reminder reads, as an object holding key, how the field is named in an import or an export, and label, what it is called on the contact. Null for a manual reminder."
                                                            },
                                                            "contact": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The contact the reminder is about.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the contact."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name of the contact."
                                                                    }
                                                                }
                                                            },
                                                            "group": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The group the reminder is about, as an object holding id and name. Always null here, since these reminders are about a contact. A reminder about a group is read from the group reminders endpoints."
                                                            },
                                                            "cadence": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "How often it comes back: once, weekly, monthly or yearly."
                                                            },
                                                            "interval": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How many of those between two dates. Every 3 months is monthly with an interval of 3."
                                                            },
                                                            "time": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The local hour it is told at, on the day itself."
                                                            },
                                                            "timezone": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The time zone that hour is read in, fixed when the reminder was made."
                                                            },
                                                            "is_active": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether it still produces dates. A reminder about an archived contact, or one whose date was cleared, stops and says why."
                                                            },
                                                            "inactive_reason": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Why it stopped: value_cleared, record_archived, record_deleted or field_removed. Null while it is active."
                                                            },
                                                            "next_date": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The next date it comes due, or null when nothing is ahead of it."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the reminder was made, as a count of seconds since 1970."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "reminder",
                                            "id": "4e7b2c90-3d15-4a86-9f21-8b0c6e5d7a13",
                                            "attributes": {
                                                "name": "Ask how the art school application went",
                                                "source": "manual",
                                                "starts_on": "2026-10-14",
                                                "field": null,
                                                "contact": {
                                                    "id": "0b6d2f4e-8a13-4c57-9e02-6f3a1d8b7c45",
                                                    "name": "Pam Beesly"
                                                },
                                                "group": null,
                                                "cadence": "monthly",
                                                "interval": 1,
                                                "time": "09:00",
                                                "timezone": "America/New_York",
                                                "is_active": true,
                                                "inactive_reason": null,
                                                "next_date": "2026-10-14",
                                                "created_at": 1790380800
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/pam-beesly/reminders/4e7b2c90-3d15-4a86-9f21-8b0c6e5d7a13"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "reminders-index-query",
                "tags": [
                    "Reminders"
                ],
                "summary": "List a contact's reminders",
                "description": "List every reminder about one contact, the ones written by hand and the ones reading a date on their page.\n\nA reminder is told on its day, once on each channel you switched on, and never again. Nothing is sent ahead of the day.\n\nDeleted reminders are left out. The answers given to their dates stay, and are read from the dates endpoint.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the contact lives in, named either by the readable name it reports as slug or by its id.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "contact",
                        "in": "path",
                        "required": true,
                        "description": "The contact the reminders are about, named either by its slug or by its id. A contact addressed through the wrong vault answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "page": {
                                        "type": "integer",
                                        "default": 1,
                                        "description": "Which page to answer with."
                                    },
                                    "per_page": {
                                        "type": "integer",
                                        "default": 25,
                                        "description": "How many records one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "A page of reminder objects, and how many there are in all.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The reminders on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One reminder.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always reminder. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the reminder says when it comes due."
                                                            },
                                                            "source": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Where its date comes from: manual when somebody wrote the reminder with a date of its own, field_value when it reads a date on the contact, such as a birthday."
                                                            },
                                                            "starts_on": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The first date of a manual reminder, written as a year, a month and a day. Null for a reminder that reads a date on the contact."
                                                            },
                                                            "field": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The date on the contact the reminder reads, as an object holding key, how the field is named in an import or an export, and label, what it is called on the contact. Null for a manual reminder."
                                                            },
                                                            "contact": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The contact the reminder is about.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the contact."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name of the contact."
                                                                    }
                                                                }
                                                            },
                                                            "group": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The group the reminder is about, as an object holding id and name. Always null here, since these reminders are about a contact. A reminder about a group is read from the group reminders endpoints."
                                                            },
                                                            "cadence": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "How often it comes back: once, weekly, monthly or yearly."
                                                            },
                                                            "interval": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How many of those between two dates. Every 3 months is monthly with an interval of 3."
                                                            },
                                                            "time": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The local hour it is told at, on the day itself."
                                                            },
                                                            "timezone": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The time zone that hour is read in, fixed when the reminder was made."
                                                            },
                                                            "is_active": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether it still produces dates. A reminder about an archived contact, or one whose date was cleared, stops and says why."
                                                            },
                                                            "inactive_reason": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Why it stopped: value_cleared, record_archived, record_deleted or field_removed. Null while it is active."
                                                            },
                                                            "next_date": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The next date it comes due, or null when nothing is ahead of it."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the reminder was made, as a count of seconds since 1970."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "reminder",
                                            "id": "4e7b2c90-3d15-4a86-9f21-8b0c6e5d7a13",
                                            "attributes": {
                                                "name": "Ask how the art school application went",
                                                "source": "manual",
                                                "starts_on": "2026-10-14",
                                                "field": null,
                                                "contact": {
                                                    "id": "0b6d2f4e-8a13-4c57-9e02-6f3a1d8b7c45",
                                                    "name": "Pam Beesly"
                                                },
                                                "group": null,
                                                "cadence": "monthly",
                                                "interval": 1,
                                                "time": "09:00",
                                                "timezone": "America/New_York",
                                                "is_active": true,
                                                "inactive_reason": null,
                                                "next_date": "2026-10-14",
                                                "created_at": 1790380800
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/pam-beesly/reminders/4e7b2c90-3d15-4a86-9f21-8b0c6e5d7a13"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "post": {
                "operationId": "reminders-create",
                "tags": [
                    "Reminders"
                ],
                "summary": "Add a reminder",
                "description": "Write a reminder about a contact with a date of its own.\n\nA reminder reading a date on the contact, such as a birthday, is asked for on the contact's page and cannot be made here.\n\nA reminder cannot start before today. One that happens once, dated today, whose hour has already passed, is refused with 422, since there would be nothing left to tell you about.\n\nA refusal names the field it is about: name, starts_on, interval, time or timezone.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the contact lives in, named either by the readable name it reports as slug or by its id.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "contact",
                        "in": "path",
                        "required": true,
                        "description": "The contact the reminders are about, named either by its slug or by its id. A contact addressed through the wrong vault answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "description": "What the reminder says. Up to 255 characters, reduced to plain text."
                                    },
                                    "starts_on": {
                                        "type": "string",
                                        "description": "The first date, written as a year, a month and a day."
                                    },
                                    "cadence": {
                                        "type": "string",
                                        "description": "One of once, weekly, monthly or yearly."
                                    },
                                    "interval": {
                                        "type": "integer",
                                        "description": "How many of those between two dates, from 1 to 99. Ignored for once."
                                    },
                                    "time": {
                                        "type": "string",
                                        "description": "The local hour to be told at, as hours and minutes."
                                    },
                                    "timezone": {
                                        "type": "string",
                                        "description": "The time zone that hour is read in. Your own when left out."
                                    }
                                },
                                "required": [
                                    "name",
                                    "starts_on",
                                    "cadence",
                                    "time"
                                ]
                            },
                            "example": {
                                "name": "Ask how the art school application went",
                                "starts_on": "2026-10-14",
                                "cadence": "monthly",
                                "interval": 1,
                                "time": "09:00",
                                "timezone": "America/New_York"
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The reminder object that was added.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The reminder.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always reminder. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the reminder says when it comes due."
                                                        },
                                                        "source": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where its date comes from: manual when somebody wrote the reminder with a date of its own, field_value when it reads a date on the contact, such as a birthday."
                                                        },
                                                        "starts_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The first date of a manual reminder, written as a year, a month and a day. Null for a reminder that reads a date on the contact."
                                                        },
                                                        "field": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The date on the contact the reminder reads, as an object holding key, how the field is named in an import or an export, and label, what it is called on the contact. Null for a manual reminder."
                                                        },
                                                        "contact": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The contact the reminder is about.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the contact."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The name of the contact."
                                                                }
                                                            }
                                                        },
                                                        "group": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The group the reminder is about, as an object holding id and name. Always null here, since these reminders are about a contact. A reminder about a group is read from the group reminders endpoints."
                                                        },
                                                        "cadence": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How often it comes back: once, weekly, monthly or yearly."
                                                        },
                                                        "interval": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many of those between two dates. Every 3 months is monthly with an interval of 3."
                                                        },
                                                        "time": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The local hour it is told at, on the day itself."
                                                        },
                                                        "timezone": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The time zone that hour is read in, fixed when the reminder was made."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether it still produces dates. A reminder about an archived contact, or one whose date was cleared, stops and says why."
                                                        },
                                                        "inactive_reason": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Why it stopped: value_cleared, record_archived, record_deleted or field_removed. Null while it is active."
                                                        },
                                                        "next_date": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The next date it comes due, or null when nothing is ahead of it."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the reminder was made, as a count of seconds since 1970."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "reminder",
                                        "id": "4e7b2c90-3d15-4a86-9f21-8b0c6e5d7a13",
                                        "attributes": {
                                            "name": "Ask how the art school application went",
                                            "source": "manual",
                                            "starts_on": "2026-10-14",
                                            "field": null,
                                            "contact": {
                                                "id": "0b6d2f4e-8a13-4c57-9e02-6f3a1d8b7c45",
                                                "name": "Pam Beesly"
                                            },
                                            "group": null,
                                            "cadence": "monthly",
                                            "interval": 1,
                                            "time": "09:00",
                                            "timezone": "America/New_York",
                                            "is_active": true,
                                            "inactive_reason": null,
                                            "next_date": "2026-10-14",
                                            "created_at": 1790380800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/pam-beesly/reminders/4e7b2c90-3d15-4a86-9f21-8b0c6e5d7a13"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/contacts/{contact}/reminders/{reminder}": {
            "get": {
                "operationId": "reminders-show",
                "tags": [
                    "Reminders"
                ],
                "summary": "Get a reminder",
                "description": "Retrieve one reminder about a contact.\n\nThe dates it produced, and what was answered for each, are read from the dates endpoint.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the contact lives in, named either by the readable name it reports as slug or by its id.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "contact",
                        "in": "path",
                        "required": true,
                        "description": "The contact the reminders are about, named either by its slug or by its id. A contact addressed through the wrong vault answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "reminder",
                        "in": "path",
                        "required": true,
                        "description": "The id of the reminder. A reminder about somebody else answers 404, and so does a deleted one.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A reminder object.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The reminder.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always reminder. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the reminder says when it comes due."
                                                        },
                                                        "source": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where its date comes from: manual when somebody wrote the reminder with a date of its own, field_value when it reads a date on the contact, such as a birthday."
                                                        },
                                                        "starts_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The first date of a manual reminder, written as a year, a month and a day. Null for a reminder that reads a date on the contact."
                                                        },
                                                        "field": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The date on the contact the reminder reads, as an object holding key, how the field is named in an import or an export, and label, what it is called on the contact. Null for a manual reminder."
                                                        },
                                                        "contact": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The contact the reminder is about.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the contact."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The name of the contact."
                                                                }
                                                            }
                                                        },
                                                        "group": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The group the reminder is about, as an object holding id and name. Always null here, since these reminders are about a contact. A reminder about a group is read from the group reminders endpoints."
                                                        },
                                                        "cadence": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How often it comes back: once, weekly, monthly or yearly."
                                                        },
                                                        "interval": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many of those between two dates. Every 3 months is monthly with an interval of 3."
                                                        },
                                                        "time": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The local hour it is told at, on the day itself."
                                                        },
                                                        "timezone": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The time zone that hour is read in, fixed when the reminder was made."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether it still produces dates. A reminder about an archived contact, or one whose date was cleared, stops and says why."
                                                        },
                                                        "inactive_reason": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Why it stopped: value_cleared, record_archived, record_deleted or field_removed. Null while it is active."
                                                        },
                                                        "next_date": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The next date it comes due, or null when nothing is ahead of it."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the reminder was made, as a count of seconds since 1970."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "reminder",
                                        "id": "4e7b2c90-3d15-4a86-9f21-8b0c6e5d7a13",
                                        "attributes": {
                                            "name": "Ask how the art school application went",
                                            "source": "manual",
                                            "starts_on": "2026-10-14",
                                            "field": null,
                                            "contact": {
                                                "id": "0b6d2f4e-8a13-4c57-9e02-6f3a1d8b7c45",
                                                "name": "Pam Beesly"
                                            },
                                            "group": null,
                                            "cadence": "monthly",
                                            "interval": 1,
                                            "time": "09:00",
                                            "timezone": "America/New_York",
                                            "is_active": true,
                                            "inactive_reason": null,
                                            "next_date": "2026-10-14",
                                            "created_at": 1790380800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/pam-beesly/reminders/4e7b2c90-3d15-4a86-9f21-8b0c6e5d7a13"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "reminders-show-query",
                "tags": [
                    "Reminders"
                ],
                "summary": "Get a reminder",
                "description": "Retrieve one reminder about a contact.\n\nThe dates it produced, and what was answered for each, are read from the dates endpoint.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the contact lives in, named either by the readable name it reports as slug or by its id.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "contact",
                        "in": "path",
                        "required": true,
                        "description": "The contact the reminders are about, named either by its slug or by its id. A contact addressed through the wrong vault answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "reminder",
                        "in": "path",
                        "required": true,
                        "description": "The id of the reminder. A reminder about somebody else answers 404, and so does a deleted one.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A reminder object.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The reminder.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always reminder. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the reminder says when it comes due."
                                                        },
                                                        "source": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where its date comes from: manual when somebody wrote the reminder with a date of its own, field_value when it reads a date on the contact, such as a birthday."
                                                        },
                                                        "starts_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The first date of a manual reminder, written as a year, a month and a day. Null for a reminder that reads a date on the contact."
                                                        },
                                                        "field": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The date on the contact the reminder reads, as an object holding key, how the field is named in an import or an export, and label, what it is called on the contact. Null for a manual reminder."
                                                        },
                                                        "contact": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The contact the reminder is about.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the contact."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The name of the contact."
                                                                }
                                                            }
                                                        },
                                                        "group": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The group the reminder is about, as an object holding id and name. Always null here, since these reminders are about a contact. A reminder about a group is read from the group reminders endpoints."
                                                        },
                                                        "cadence": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How often it comes back: once, weekly, monthly or yearly."
                                                        },
                                                        "interval": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many of those between two dates. Every 3 months is monthly with an interval of 3."
                                                        },
                                                        "time": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The local hour it is told at, on the day itself."
                                                        },
                                                        "timezone": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The time zone that hour is read in, fixed when the reminder was made."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether it still produces dates. A reminder about an archived contact, or one whose date was cleared, stops and says why."
                                                        },
                                                        "inactive_reason": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Why it stopped: value_cleared, record_archived, record_deleted or field_removed. Null while it is active."
                                                        },
                                                        "next_date": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The next date it comes due, or null when nothing is ahead of it."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the reminder was made, as a count of seconds since 1970."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "reminder",
                                        "id": "4e7b2c90-3d15-4a86-9f21-8b0c6e5d7a13",
                                        "attributes": {
                                            "name": "Ask how the art school application went",
                                            "source": "manual",
                                            "starts_on": "2026-10-14",
                                            "field": null,
                                            "contact": {
                                                "id": "0b6d2f4e-8a13-4c57-9e02-6f3a1d8b7c45",
                                                "name": "Pam Beesly"
                                            },
                                            "group": null,
                                            "cadence": "monthly",
                                            "interval": 1,
                                            "time": "09:00",
                                            "timezone": "America/New_York",
                                            "is_active": true,
                                            "inactive_reason": null,
                                            "next_date": "2026-10-14",
                                            "created_at": 1790380800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/pam-beesly/reminders/4e7b2c90-3d15-4a86-9f21-8b0c6e5d7a13"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "put": {
                "operationId": "reminders-update",
                "tags": [
                    "Reminders"
                ],
                "summary": "Change a reminder",
                "description": "Change what a reminder says and when it comes back.\n\nChanging the schedule replaces the dates after today that nobody answered. Today's date and the overdue ones stay as they are, and no answer already given is ever changed.\n\nOnly a manual reminder has a first date of its own. Sending starts_on for one that reads a date on the contact answers 422.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the contact lives in, named either by the readable name it reports as slug or by its id.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "contact",
                        "in": "path",
                        "required": true,
                        "description": "The contact the reminders are about, named either by its slug or by its id. A contact addressed through the wrong vault answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "reminder",
                        "in": "path",
                        "required": true,
                        "description": "The id of the reminder. A reminder about somebody else answers 404, and so does a deleted one.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "description": "What the reminder says. Up to 255 characters. It cannot be null."
                                    },
                                    "starts_on": {
                                        "type": "string",
                                        "description": "A new first date, for a manual reminder only."
                                    },
                                    "cadence": {
                                        "type": "string",
                                        "description": "One of once, weekly, monthly or yearly. It cannot be null."
                                    },
                                    "interval": {
                                        "type": "integer",
                                        "description": "How many of those between two dates, from 1 to 99."
                                    },
                                    "time": {
                                        "type": "string",
                                        "description": "The local hour to be told at. It cannot be null."
                                    },
                                    "timezone": {
                                        "type": "string",
                                        "description": "A new time zone."
                                    }
                                }
                            },
                            "example": {
                                "name": "Ask how the art school application went",
                                "starts_on": "2026-10-14",
                                "cadence": "monthly",
                                "interval": 1,
                                "time": "09:00",
                                "timezone": "America/New_York"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The reminder object as it stands now.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The reminder.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always reminder. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the reminder says when it comes due."
                                                        },
                                                        "source": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where its date comes from: manual when somebody wrote the reminder with a date of its own, field_value when it reads a date on the contact, such as a birthday."
                                                        },
                                                        "starts_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The first date of a manual reminder, written as a year, a month and a day. Null for a reminder that reads a date on the contact."
                                                        },
                                                        "field": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The date on the contact the reminder reads, as an object holding key, how the field is named in an import or an export, and label, what it is called on the contact. Null for a manual reminder."
                                                        },
                                                        "contact": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The contact the reminder is about.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the contact."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The name of the contact."
                                                                }
                                                            }
                                                        },
                                                        "group": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The group the reminder is about, as an object holding id and name. Always null here, since these reminders are about a contact. A reminder about a group is read from the group reminders endpoints."
                                                        },
                                                        "cadence": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How often it comes back: once, weekly, monthly or yearly."
                                                        },
                                                        "interval": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many of those between two dates. Every 3 months is monthly with an interval of 3."
                                                        },
                                                        "time": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The local hour it is told at, on the day itself."
                                                        },
                                                        "timezone": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The time zone that hour is read in, fixed when the reminder was made."
                                                        },
                                                        "is_active": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether it still produces dates. A reminder about an archived contact, or one whose date was cleared, stops and says why."
                                                        },
                                                        "inactive_reason": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Why it stopped: value_cleared, record_archived, record_deleted or field_removed. Null while it is active."
                                                        },
                                                        "next_date": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The next date it comes due, or null when nothing is ahead of it."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the reminder was made, as a count of seconds since 1970."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "reminder",
                                        "id": "4e7b2c90-3d15-4a86-9f21-8b0c6e5d7a13",
                                        "attributes": {
                                            "name": "Ask how the art school application went",
                                            "source": "manual",
                                            "starts_on": "2026-10-14",
                                            "field": null,
                                            "contact": {
                                                "id": "0b6d2f4e-8a13-4c57-9e02-6f3a1d8b7c45",
                                                "name": "Pam Beesly"
                                            },
                                            "group": null,
                                            "cadence": "monthly",
                                            "interval": 1,
                                            "time": "09:00",
                                            "timezone": "America/New_York",
                                            "is_active": true,
                                            "inactive_reason": null,
                                            "next_date": "2026-10-14",
                                            "created_at": 1790380800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/pam-beesly/reminders/4e7b2c90-3d15-4a86-9f21-8b0c6e5d7a13"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "delete": {
                "operationId": "reminders-destroy",
                "tags": [
                    "Reminders"
                ],
                "summary": "Delete a reminder",
                "description": "Stop a reminder for good. There is no pause: deleting is the only way to stop one.\n\nNothing further is delivered, and the dates still waiting for an answer are dropped. The answers already given stay, and are still read from the dates endpoint.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the contact lives in, named either by the readable name it reports as slug or by its id.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "contact",
                        "in": "path",
                        "required": true,
                        "description": "The contact the reminders are about, named either by its slug or by its id. A contact addressed through the wrong vault answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "reminder",
                        "in": "path",
                        "required": true,
                        "description": "The id of the reminder. A reminder about somebody else answers 404, and so does a deleted one.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Nothing at all."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/contacts/{contact}/reminder-occurrences": {
            "get": {
                "operationId": "reminder-occurrences-index",
                "tags": [
                    "Reminders"
                ],
                "summary": "List a contact's reminder dates",
                "description": "List the dates the reminders about a contact produced, with what was answered for each.\n\nWithout a category, every date is listed, newest first, so any date can be looked up: remembered, forgotten, or never answered.\n\nupcoming lists the next date of each active reminder. A date too far off to have been generated yet comes back with a null id, and cannot be answered, which nothing upcoming can be anyway.\n\nhistory lists the answered dates, the latest answer first, including those of reminders deleted since.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the contact lives in, named either by the readable name it reports as slug or by its id.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "contact",
                        "in": "path",
                        "required": true,
                        "description": "The contact the reminders are about, named either by its slug or by its id. A contact addressed through the wrong vault answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "category",
                        "in": "query",
                        "required": false,
                        "description": "One of overdue, today, upcoming or history.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to answer with.",
                        "schema": {
                            "type": "integer",
                            "default": 1
                        }
                    },
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "How many records one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused.",
                        "schema": {
                            "type": "integer",
                            "default": 25
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of reminder date objects, and how many there are in all.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The dates on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One date.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always reminder_occurrence. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "reminder": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "format": "uuid",
                                                                "description": "The reminder this date belongs to."
                                                            },
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the reminder says."
                                                            },
                                                            "group": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The group the reminder is about, as an object holding id and name. Always null here, since these dates belong to reminders about a contact."
                                                            },
                                                            "date": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The day it falls on, written as a year, a month and a day, in the reminder's time zone."
                                                            },
                                                            "scheduled_for": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "The instant it is told at, as a count of seconds since 1970."
                                                            },
                                                            "category": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Where it stands while it waits for an answer, read against today in your time zone: upcoming before its day, today on its day, overdue from the day after. Null once it is answered or cancelled."
                                                            },
                                                            "answer": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What you said about this date: remembered or forgotten. Null while nobody answered. No answer is ever filled in for you, and a notification sent or read never counts as one."
                                                            },
                                                            "answered_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the answer was given, as a count of seconds, or null."
                                                            },
                                                            "cancelled_reason": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Why the date will not be asked about any more: rule_deleted, record_archived, record_deleted, field_removed, value_cleared, source_changed or rule_changed. Null otherwise. A cancelled date is never counted as forgotten."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find what this date belongs to.",
                                                        "properties": {
                                                            "reminder": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address of the reminder, or null once the reminder was deleted."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "reminder_occurrence",
                                            "id": "a9d3f6e1-2b47-4c08-8e5a-17f4c0b9d262",
                                            "attributes": {
                                                "reminder": "4e7b2c90-3d15-4a86-9f21-8b0c6e5d7a13",
                                                "name": "Ask how the art school application went",
                                                "group": null,
                                                "date": "2026-09-14",
                                                "scheduled_for": 1789390800,
                                                "category": null,
                                                "answer": "remembered",
                                                "answered_at": 1789394400,
                                                "cancelled_reason": null
                                            },
                                            "links": {
                                                "reminder": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/pam-beesly/reminders/4e7b2c90-3d15-4a86-9f21-8b0c6e5d7a13"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "reminder-occurrences-index-query",
                "tags": [
                    "Reminders"
                ],
                "summary": "List a contact's reminder dates",
                "description": "List the dates the reminders about a contact produced, with what was answered for each.\n\nWithout a category, every date is listed, newest first, so any date can be looked up: remembered, forgotten, or never answered.\n\nupcoming lists the next date of each active reminder. A date too far off to have been generated yet comes back with a null id, and cannot be answered, which nothing upcoming can be anyway.\n\nhistory lists the answered dates, the latest answer first, including those of reminders deleted since.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the contact lives in, named either by the readable name it reports as slug or by its id.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "contact",
                        "in": "path",
                        "required": true,
                        "description": "The contact the reminders are about, named either by its slug or by its id. A contact addressed through the wrong vault answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "category": {
                                        "type": "string",
                                        "description": "One of overdue, today, upcoming or history."
                                    },
                                    "page": {
                                        "type": "integer",
                                        "default": 1,
                                        "description": "Which page to answer with."
                                    },
                                    "per_page": {
                                        "type": "integer",
                                        "default": 25,
                                        "description": "How many records one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "A page of reminder date objects, and how many there are in all.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The dates on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One date.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always reminder_occurrence. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "reminder": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "format": "uuid",
                                                                "description": "The reminder this date belongs to."
                                                            },
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the reminder says."
                                                            },
                                                            "group": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The group the reminder is about, as an object holding id and name. Always null here, since these dates belong to reminders about a contact."
                                                            },
                                                            "date": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The day it falls on, written as a year, a month and a day, in the reminder's time zone."
                                                            },
                                                            "scheduled_for": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "The instant it is told at, as a count of seconds since 1970."
                                                            },
                                                            "category": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Where it stands while it waits for an answer, read against today in your time zone: upcoming before its day, today on its day, overdue from the day after. Null once it is answered or cancelled."
                                                            },
                                                            "answer": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What you said about this date: remembered or forgotten. Null while nobody answered. No answer is ever filled in for you, and a notification sent or read never counts as one."
                                                            },
                                                            "answered_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the answer was given, as a count of seconds, or null."
                                                            },
                                                            "cancelled_reason": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Why the date will not be asked about any more: rule_deleted, record_archived, record_deleted, field_removed, value_cleared, source_changed or rule_changed. Null otherwise. A cancelled date is never counted as forgotten."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find what this date belongs to.",
                                                        "properties": {
                                                            "reminder": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address of the reminder, or null once the reminder was deleted."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "reminder_occurrence",
                                            "id": "a9d3f6e1-2b47-4c08-8e5a-17f4c0b9d262",
                                            "attributes": {
                                                "reminder": "4e7b2c90-3d15-4a86-9f21-8b0c6e5d7a13",
                                                "name": "Ask how the art school application went",
                                                "group": null,
                                                "date": "2026-09-14",
                                                "scheduled_for": 1789390800,
                                                "category": null,
                                                "answer": "remembered",
                                                "answered_at": 1789394400,
                                                "cancelled_reason": null
                                            },
                                            "links": {
                                                "reminder": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/pam-beesly/reminders/4e7b2c90-3d15-4a86-9f21-8b0c6e5d7a13"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/contacts/{contact}/reminder-occurrences/{occurrence}/answer": {
            "put": {
                "operationId": "reminder-occurrences-answer",
                "tags": [
                    "Reminders"
                ],
                "summary": "Answer a reminder date",
                "description": "Say whether you remembered a date or forgot it. The answer is final.\n\nremembered is accepted from the date's own day. forgotten is accepted from the day after. Both are read against today in your time zone, and anything earlier answers 422.\n\nAn answer cannot be changed or taken back, and a second answer for the same date answers 422, whatever it says. A cancelled date answers 422 too.\n\nAnswering drops the notifications for that date not sent yet, and touches no other date: next year's birthday is still waiting.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the contact lives in, named either by the readable name it reports as slug or by its id.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "contact",
                        "in": "path",
                        "required": true,
                        "description": "The contact the reminders are about, named either by its slug or by its id. A contact addressed through the wrong vault answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "occurrence",
                        "in": "path",
                        "required": true,
                        "description": "The id of the date.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "answer": {
                                        "type": "string",
                                        "description": "remembered or forgotten."
                                    }
                                },
                                "required": [
                                    "answer"
                                ]
                            },
                            "example": {
                                "answer": "remembered"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The reminder date object, with its answer.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The date.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always reminder_occurrence. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "reminder": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The reminder this date belongs to."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the reminder says."
                                                        },
                                                        "group": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The group the reminder is about, as an object holding id and name. Always null here, since these dates belong to reminders about a contact."
                                                        },
                                                        "date": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day it falls on, written as a year, a month and a day, in the reminder's time zone."
                                                        },
                                                        "scheduled_for": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The instant it is told at, as a count of seconds since 1970."
                                                        },
                                                        "category": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where it stands while it waits for an answer, read against today in your time zone: upcoming before its day, today on its day, overdue from the day after. Null once it is answered or cancelled."
                                                        },
                                                        "answer": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What you said about this date: remembered or forgotten. Null while nobody answered. No answer is ever filled in for you, and a notification sent or read never counts as one."
                                                        },
                                                        "answered_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the answer was given, as a count of seconds, or null."
                                                        },
                                                        "cancelled_reason": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Why the date will not be asked about any more: rule_deleted, record_archived, record_deleted, field_removed, value_cleared, source_changed or rule_changed. Null otherwise. A cancelled date is never counted as forgotten."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find what this date belongs to.",
                                                    "properties": {
                                                        "reminder": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address of the reminder."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "reminder_occurrence",
                                        "id": "a9d3f6e1-2b47-4c08-8e5a-17f4c0b9d262",
                                        "attributes": {
                                            "reminder": "4e7b2c90-3d15-4a86-9f21-8b0c6e5d7a13",
                                            "name": "Ask how the art school application went",
                                            "group": null,
                                            "date": "2026-09-14",
                                            "scheduled_for": 1789390800,
                                            "category": null,
                                            "answer": "remembered",
                                            "answered_at": 1789394400,
                                            "cancelled_reason": null
                                        },
                                        "links": {
                                            "reminder": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/pam-beesly/reminders/4e7b2c90-3d15-4a86-9f21-8b0c6e5d7a13"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/reminders": {
            "get": {
                "operationId": "vault-reminders-index",
                "tags": [
                    "Reminders"
                ],
                "summary": "List a vault's reminders",
                "description": "List every reminder of a vault about a contact or a group, whatever its date: the ones still producing dates, the ones that stopped, and the ones whose next date is far off.\n\nEach reminder names who it is about: contact holds the contact, group holds the group, and the other one is null. The reminders are listed in the order they were made.\n\nDeleted reminders are left out. While groups are not available to your account, the reminders about a group are left out too.\n\nThis lists the reminders themselves. The dates they produce, and what was answered for each, are read from the vault's dates endpoint.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "about",
                        "in": "query",
                        "required": false,
                        "description": "contact keeps the reminders about a contact, group the reminders about a group. Left out, both are listed. Anything else answers 422.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to answer with.",
                        "schema": {
                            "type": "integer",
                            "default": 1
                        }
                    },
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "How many records one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused.",
                        "schema": {
                            "type": "integer",
                            "default": 25
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of reminder objects, and how many there are in all. A vault of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The reminders on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One reminder.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always reminder. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the reminder says when it comes due."
                                                            },
                                                            "source": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Where its date comes from: manual when somebody wrote the reminder with a date of its own, field_value when it reads a date on the contact, such as a birthday."
                                                            },
                                                            "starts_on": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The first date of a manual reminder, written as a year, a month and a day. Null for a reminder that reads a date on the contact."
                                                            },
                                                            "field": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The date on the contact the reminder reads, as an object holding key and label. Null for a manual reminder, and always null for a group."
                                                            },
                                                            "contact": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The contact the reminder is about, or null for a reminder about a group.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the contact."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name of the contact."
                                                                    }
                                                                }
                                                            },
                                                            "group": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The group the reminder is about, as an object holding id and name, or null for a reminder about a contact."
                                                            },
                                                            "cadence": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "How often it comes back: once, weekly, monthly or yearly."
                                                            },
                                                            "interval": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How many of those between two dates. Every 3 months is monthly with an interval of 3."
                                                            },
                                                            "time": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The local hour it is told at, on the day itself."
                                                            },
                                                            "timezone": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The time zone that hour is read in, fixed when the reminder was made."
                                                            },
                                                            "is_active": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether it still produces dates. A reminder about an archived contact, or one whose date was cleared, stops and says why."
                                                            },
                                                            "inactive_reason": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Why it stopped: value_cleared, record_archived, record_deleted or field_removed. Null while it is active."
                                                            },
                                                            "next_date": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The next date it comes due, or null when nothing is ahead of it."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the reminder was made, as a count of seconds since 1970."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "reminder",
                                            "id": "4e7b2c90-3d15-4a86-9f21-8b0c6e5d7a13",
                                            "attributes": {
                                                "name": "Ask how the art school application went",
                                                "source": "manual",
                                                "starts_on": "2026-10-14",
                                                "field": null,
                                                "contact": {
                                                    "id": "0b6d2f4e-8a13-4c57-9e02-6f3a1d8b7c45",
                                                    "name": "Pam Beesly"
                                                },
                                                "group": null,
                                                "cadence": "monthly",
                                                "interval": 1,
                                                "time": "09:00",
                                                "timezone": "America/New_York",
                                                "is_active": true,
                                                "inactive_reason": null,
                                                "next_date": "2026-10-14",
                                                "created_at": 1790380800
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/pam-beesly/reminders/4e7b2c90-3d15-4a86-9f21-8b0c6e5d7a13"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "vault-reminders-index-query",
                "tags": [
                    "Reminders"
                ],
                "summary": "List a vault's reminders",
                "description": "List every reminder of a vault about a contact or a group, whatever its date: the ones still producing dates, the ones that stopped, and the ones whose next date is far off.\n\nEach reminder names who it is about: contact holds the contact, group holds the group, and the other one is null. The reminders are listed in the order they were made.\n\nDeleted reminders are left out. While groups are not available to your account, the reminders about a group are left out too.\n\nThis lists the reminders themselves. The dates they produce, and what was answered for each, are read from the vault's dates endpoint.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "about": {
                                        "type": "string",
                                        "description": "contact keeps the reminders about a contact, group the reminders about a group. Left out, both are listed. Anything else answers 422."
                                    },
                                    "page": {
                                        "type": "integer",
                                        "default": 1,
                                        "description": "Which page to answer with."
                                    },
                                    "per_page": {
                                        "type": "integer",
                                        "default": 25,
                                        "description": "How many records one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "A page of reminder objects, and how many there are in all. A vault of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The reminders on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One reminder.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always reminder. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the reminder says when it comes due."
                                                            },
                                                            "source": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Where its date comes from: manual when somebody wrote the reminder with a date of its own, field_value when it reads a date on the contact, such as a birthday."
                                                            },
                                                            "starts_on": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The first date of a manual reminder, written as a year, a month and a day. Null for a reminder that reads a date on the contact."
                                                            },
                                                            "field": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The date on the contact the reminder reads, as an object holding key and label. Null for a manual reminder, and always null for a group."
                                                            },
                                                            "contact": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The contact the reminder is about, or null for a reminder about a group.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the contact."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name of the contact."
                                                                    }
                                                                }
                                                            },
                                                            "group": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The group the reminder is about, as an object holding id and name, or null for a reminder about a contact."
                                                            },
                                                            "cadence": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "How often it comes back: once, weekly, monthly or yearly."
                                                            },
                                                            "interval": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How many of those between two dates. Every 3 months is monthly with an interval of 3."
                                                            },
                                                            "time": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The local hour it is told at, on the day itself."
                                                            },
                                                            "timezone": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The time zone that hour is read in, fixed when the reminder was made."
                                                            },
                                                            "is_active": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether it still produces dates. A reminder about an archived contact, or one whose date was cleared, stops and says why."
                                                            },
                                                            "inactive_reason": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Why it stopped: value_cleared, record_archived, record_deleted or field_removed. Null while it is active."
                                                            },
                                                            "next_date": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The next date it comes due, or null when nothing is ahead of it."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the reminder was made, as a count of seconds since 1970."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "reminder",
                                            "id": "4e7b2c90-3d15-4a86-9f21-8b0c6e5d7a13",
                                            "attributes": {
                                                "name": "Ask how the art school application went",
                                                "source": "manual",
                                                "starts_on": "2026-10-14",
                                                "field": null,
                                                "contact": {
                                                    "id": "0b6d2f4e-8a13-4c57-9e02-6f3a1d8b7c45",
                                                    "name": "Pam Beesly"
                                                },
                                                "group": null,
                                                "cadence": "monthly",
                                                "interval": 1,
                                                "time": "09:00",
                                                "timezone": "America/New_York",
                                                "is_active": true,
                                                "inactive_reason": null,
                                                "next_date": "2026-10-14",
                                                "created_at": 1790380800
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/pam-beesly/reminders/4e7b2c90-3d15-4a86-9f21-8b0c6e5d7a13"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/reminder-occurrences": {
            "get": {
                "operationId": "vault-reminder-occurrences-index",
                "tags": [
                    "Reminders"
                ],
                "summary": "List a vault's reminder dates",
                "description": "List the dates of a whole vault, for every contact, group and record in it: what is overdue, what falls today and what comes next. The same dates as the vault dashboard.\n\nWithout a category, the dates overdue, today and upcoming are listed together, earliest first, as the vault dashboard lists them. This differs from the dates of one contact, which list every date newest first.\n\nupcoming lists the next date of each active reminder up to days ahead. A date too far off to have been generated yet comes back with a null id, and cannot be answered.\n\nhistory lists the answered dates, the latest answer first, including those of reminders deleted since.\n\nkind=birthdays keeps the birthdays only. It also lists the birthdays nobody asked to be reminded of, falling today or within days: those come back with the type birthday, a null id, the attributes date, category, subject and age, and a links.contact pointing at the contact. They are never overdue and never in the history, since there is nothing to answer. A birthday held in a sensitive field is left out unless your key may read sensitive fields.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault, named either by the readable name it reports as slug or by its id.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "category",
                        "in": "query",
                        "required": false,
                        "description": "One of overdue, today, upcoming or history.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "kind",
                        "in": "query",
                        "required": false,
                        "description": "all for every reminder, birthdays for birthdays only.",
                        "schema": {
                            "type": "string",
                            "default": "all"
                        }
                    },
                    {
                        "name": "days",
                        "in": "query",
                        "required": false,
                        "description": "How many days ahead upcoming reaches, between 1 and 365.",
                        "schema": {
                            "type": "integer",
                            "default": 7
                        }
                    },
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to answer with.",
                        "schema": {
                            "type": "integer",
                            "default": 1
                        }
                    },
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "How many records one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused.",
                        "schema": {
                            "type": "integer",
                            "default": 25
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of reminder date objects, and of birthdays when they are asked for, and how many there are in all.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The dates on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One date.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always reminder_occurrence. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "reminder": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "format": "uuid",
                                                                "description": "The reminder this date belongs to."
                                                            },
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the reminder says."
                                                            },
                                                            "group": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The group the reminder is about, as an object holding id and name, or null for a reminder about anything else."
                                                            },
                                                            "date": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The day it falls on, written as a year, a month and a day, in the reminder's time zone."
                                                            },
                                                            "scheduled_for": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "The instant it is told at, as a count of seconds since 1970."
                                                            },
                                                            "category": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Where it stands while it waits for an answer, read against today in your time zone: upcoming before its day, today on its day, overdue from the day after. Null once it is answered or cancelled."
                                                            },
                                                            "answer": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What you said about this date: remembered or forgotten. Null while nobody answered. No answer is ever filled in for you, and a notification sent or read never counts as one."
                                                            },
                                                            "answered_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the answer was given, as a count of seconds, or null."
                                                            },
                                                            "cancelled_reason": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Why the date will not be asked about any more: rule_deleted, record_archived, record_deleted, field_removed, value_cleared, source_changed or rule_changed. Null otherwise. A cancelled date is never counted as forgotten."
                                                            },
                                                            "subject": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "Who or what the date is about, or null once that record is gone.",
                                                                "properties": {
                                                                    "type": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "contact, group or entity, an entity being a record of a type you invented."
                                                                    },
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "Its id."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Its name."
                                                                    }
                                                                }
                                                            },
                                                            "age": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "For a birthday, the age reached on that day. Null when the year of birth is unknown, for any other date, and for a birthday held in a sensitive field your key may not read."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find what this date belongs to, and how to answer it.",
                                                        "properties": {
                                                            "reminder": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address of the reminder, or null once the reminder was deleted."
                                                            },
                                                            "answer": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address to answer this date at, or null when it cannot be answered: not generated yet, already answered, cancelled, or about a record of a type you invented."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "reminder_occurrence",
                                            "id": "a9d3f6e1-2b47-4c08-8e5a-17f4c0b9d262",
                                            "attributes": {
                                                "reminder": "4e7b2c90-3d15-4a86-9f21-8b0c6e5d7a13",
                                                "name": "Ask how the art school application went",
                                                "group": null,
                                                "date": "2026-09-14",
                                                "scheduled_for": 1789390800,
                                                "category": "overdue",
                                                "answer": null,
                                                "answered_at": null,
                                                "cancelled_reason": null,
                                                "subject": {
                                                    "type": "contact",
                                                    "id": "0b6d2f4e-8a13-4c57-9e02-6f3a1d8b7c45",
                                                    "name": "Pam Beesly"
                                                },
                                                "age": null
                                            },
                                            "links": {
                                                "reminder": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/pam-beesly/reminders/4e7b2c90-3d15-4a86-9f21-8b0c6e5d7a13",
                                                "answer": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/pam-beesly/reminder-occurrences/a9d3f6e1-2b47-4c08-8e5a-17f4c0b9d262/answer"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "vault-reminder-occurrences-index-query",
                "tags": [
                    "Reminders"
                ],
                "summary": "List a vault's reminder dates",
                "description": "List the dates of a whole vault, for every contact, group and record in it: what is overdue, what falls today and what comes next. The same dates as the vault dashboard.\n\nWithout a category, the dates overdue, today and upcoming are listed together, earliest first, as the vault dashboard lists them. This differs from the dates of one contact, which list every date newest first.\n\nupcoming lists the next date of each active reminder up to days ahead. A date too far off to have been generated yet comes back with a null id, and cannot be answered.\n\nhistory lists the answered dates, the latest answer first, including those of reminders deleted since.\n\nkind=birthdays keeps the birthdays only. It also lists the birthdays nobody asked to be reminded of, falling today or within days: those come back with the type birthday, a null id, the attributes date, category, subject and age, and a links.contact pointing at the contact. They are never overdue and never in the history, since there is nothing to answer. A birthday held in a sensitive field is left out unless your key may read sensitive fields.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault, named either by the readable name it reports as slug or by its id.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "category": {
                                        "type": "string",
                                        "description": "One of overdue, today, upcoming or history."
                                    },
                                    "kind": {
                                        "type": "string",
                                        "default": "all",
                                        "description": "all for every reminder, birthdays for birthdays only."
                                    },
                                    "days": {
                                        "type": "integer",
                                        "default": 7,
                                        "description": "How many days ahead upcoming reaches, between 1 and 365."
                                    },
                                    "page": {
                                        "type": "integer",
                                        "default": 1,
                                        "description": "Which page to answer with."
                                    },
                                    "per_page": {
                                        "type": "integer",
                                        "default": 25,
                                        "description": "How many records one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "A page of reminder date objects, and of birthdays when they are asked for, and how many there are in all.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The dates on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One date.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always reminder_occurrence. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "reminder": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "format": "uuid",
                                                                "description": "The reminder this date belongs to."
                                                            },
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the reminder says."
                                                            },
                                                            "group": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The group the reminder is about, as an object holding id and name, or null for a reminder about anything else."
                                                            },
                                                            "date": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The day it falls on, written as a year, a month and a day, in the reminder's time zone."
                                                            },
                                                            "scheduled_for": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "The instant it is told at, as a count of seconds since 1970."
                                                            },
                                                            "category": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Where it stands while it waits for an answer, read against today in your time zone: upcoming before its day, today on its day, overdue from the day after. Null once it is answered or cancelled."
                                                            },
                                                            "answer": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What you said about this date: remembered or forgotten. Null while nobody answered. No answer is ever filled in for you, and a notification sent or read never counts as one."
                                                            },
                                                            "answered_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the answer was given, as a count of seconds, or null."
                                                            },
                                                            "cancelled_reason": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Why the date will not be asked about any more: rule_deleted, record_archived, record_deleted, field_removed, value_cleared, source_changed or rule_changed. Null otherwise. A cancelled date is never counted as forgotten."
                                                            },
                                                            "subject": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "Who or what the date is about, or null once that record is gone.",
                                                                "properties": {
                                                                    "type": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "contact, group or entity, an entity being a record of a type you invented."
                                                                    },
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "Its id."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Its name."
                                                                    }
                                                                }
                                                            },
                                                            "age": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "For a birthday, the age reached on that day. Null when the year of birth is unknown, for any other date, and for a birthday held in a sensitive field your key may not read."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find what this date belongs to, and how to answer it.",
                                                        "properties": {
                                                            "reminder": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address of the reminder, or null once the reminder was deleted."
                                                            },
                                                            "answer": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address to answer this date at, or null when it cannot be answered: not generated yet, already answered, cancelled, or about a record of a type you invented."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "reminder_occurrence",
                                            "id": "a9d3f6e1-2b47-4c08-8e5a-17f4c0b9d262",
                                            "attributes": {
                                                "reminder": "4e7b2c90-3d15-4a86-9f21-8b0c6e5d7a13",
                                                "name": "Ask how the art school application went",
                                                "group": null,
                                                "date": "2026-09-14",
                                                "scheduled_for": 1789390800,
                                                "category": "overdue",
                                                "answer": null,
                                                "answered_at": null,
                                                "cancelled_reason": null,
                                                "subject": {
                                                    "type": "contact",
                                                    "id": "0b6d2f4e-8a13-4c57-9e02-6f3a1d8b7c45",
                                                    "name": "Pam Beesly"
                                                },
                                                "age": null
                                            },
                                            "links": {
                                                "reminder": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/pam-beesly/reminders/4e7b2c90-3d15-4a86-9f21-8b0c6e5d7a13",
                                                "answer": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/pam-beesly/reminder-occurrences/a9d3f6e1-2b47-4c08-8e5a-17f4c0b9d262/answer"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/search": {
            "get": {
                "operationId": "search-index",
                "tags": [
                    "Search"
                ],
                "summary": "Search a vault",
                "description": "Search the records of one of your vaults, or of all of them, for every word you type.\n\nA record is found when it holds every word, in any order, in its name, in any value written on it, or in the name of somebody linked to it: who took part in a life event, or who a contact has a relationship with. Case and accents are ignored, and a typing mistake is tolerated.\n\nResults come in groups, the way the product lists them: people, each entity type, then life events. Within a group, a record whose name holds the words comes before one where they are only in its values, and that one before a record found only through somebody linked to it.\n\nA value of a field marked sensitive is searched only with a key holding the sensitive-fields scope. Any other key never finds a record through such a value.\n\nSearch needs the search engine of the instance. While it cannot be reached, the endpoint answers 503 and nothing else is affected.\n\nRate limit: Sixty requests per minute, per token.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault to search, named either by the readable name it reports as slug or by its id. Both answer.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "query",
                        "in": "query",
                        "required": true,
                        "description": "The words to find, at least two characters and at most 255.",
                        "schema": {
                            "type": "string"
                        },
                        "example": "farms"
                    },
                    {
                        "name": "scope",
                        "in": "query",
                        "required": false,
                        "description": "vault to search the vault named in the path, account to search every vault of the account.",
                        "schema": {
                            "type": "string",
                            "default": "vault"
                        }
                    },
                    {
                        "name": "group",
                        "in": "query",
                        "required": false,
                        "description": "One group only, by the key a previous answer gave it, to page through it.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "The page of the group asked for.",
                        "schema": {
                            "type": "integer",
                            "default": 1
                        }
                    },
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "How many results per group, at most 100.",
                        "schema": {
                            "type": "integer",
                            "default": 25
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The groups of records found. A vault belonging to somebody else answers 404, a query under two characters 422, and an unreachable search engine 503.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The groups holding at least one result, in the order the product shows them.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One group.",
                                                "properties": {
                                                    "group": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The key of the group: people, life-events, or entity-type- followed by the entity type."
                                                    },
                                                    "label": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The name of the group, in the language of the account."
                                                    },
                                                    "total": {
                                                        "type": [
                                                            "integer",
                                                            "null"
                                                        ],
                                                        "description": "How many records the group holds in all."
                                                    },
                                                    "next_page": {
                                                        "type": [
                                                            "integer",
                                                            "null"
                                                        ],
                                                        "description": "The page to ask for next, with group, or null on the last page."
                                                    },
                                                    "results": {
                                                        "type": [
                                                            "array",
                                                            "null"
                                                        ],
                                                        "description": "The records of the group on this page, best match first.",
                                                        "items": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "One record.",
                                                            "properties": {
                                                                "type": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "contact, entity or life_event."
                                                                },
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id the record answers to on its own endpoints."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The name the record is listed under."
                                                                },
                                                                "vault": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "The vault the record lives in.",
                                                                    "properties": {
                                                                        "id": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "format": "uuid",
                                                                            "description": "The id of the vault."
                                                                        },
                                                                        "name": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The name of the vault."
                                                                        }
                                                                    }
                                                                },
                                                                "archived": {
                                                                    "type": [
                                                                        "boolean",
                                                                        "null"
                                                                    ],
                                                                    "description": "Whether the record is archived."
                                                                },
                                                                "date": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "For a life event, the day it happened, else null."
                                                                },
                                                                "matched": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "Where the words were found: the label of the value and its text, or null when the name holds them. The text of a sensitive value is always null.",
                                                                    "properties": {
                                                                        "label": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The label of the value, or of the link, the words were found in."
                                                                        },
                                                                        "excerpt": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The text of that value, or null for a sensitive value or a link."
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "group": "people",
                                            "label": "People",
                                            "total": 1,
                                            "next_page": null,
                                            "results": [
                                                {
                                                    "type": "contact",
                                                    "id": "9f1c3a2e-7b4d-4c1a-8e2f-5d6b7a8c9e01",
                                                    "name": "Dwight Schrute",
                                                    "vault": {
                                                        "id": "2c7e9b14-1f3a-4d5e-9a8b-6c4d3e2f1a07",
                                                        "name": "Dunder Mifflin"
                                                    },
                                                    "archived": false,
                                                    "date": null,
                                                    "matched": {
                                                        "label": "Employer",
                                                        "excerpt": "Schrute Farms"
                                                    }
                                                }
                                            ]
                                        }
                                    ],
                                    "meta": {
                                        "query": "farms",
                                        "scope": "vault"
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "search-index-query",
                "tags": [
                    "Search"
                ],
                "summary": "Search a vault",
                "description": "Search the records of one of your vaults, or of all of them, for every word you type.\n\nA record is found when it holds every word, in any order, in its name, in any value written on it, or in the name of somebody linked to it: who took part in a life event, or who a contact has a relationship with. Case and accents are ignored, and a typing mistake is tolerated.\n\nResults come in groups, the way the product lists them: people, each entity type, then life events. Within a group, a record whose name holds the words comes before one where they are only in its values, and that one before a record found only through somebody linked to it.\n\nA value of a field marked sensitive is searched only with a key holding the sensitive-fields scope. Any other key never finds a record through such a value.\n\nSearch needs the search engine of the instance. While it cannot be reached, the endpoint answers 503 and nothing else is affected.\n\nRate limit: Sixty requests per minute, per token.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault to search, named either by the readable name it reports as slug or by its id. Both answer.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "query": {
                                        "type": "string",
                                        "description": "The words to find, at least two characters and at most 255."
                                    },
                                    "scope": {
                                        "type": "string",
                                        "default": "vault",
                                        "description": "vault to search the vault named in the path, account to search every vault of the account."
                                    },
                                    "group": {
                                        "type": "string",
                                        "description": "One group only, by the key a previous answer gave it, to page through it."
                                    },
                                    "page": {
                                        "type": "integer",
                                        "default": 1,
                                        "description": "The page of the group asked for."
                                    },
                                    "per_page": {
                                        "type": "integer",
                                        "default": 25,
                                        "description": "How many results per group, at most 100."
                                    }
                                },
                                "required": [
                                    "query"
                                ]
                            },
                            "example": {
                                "query": "farms"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The groups of records found. A vault belonging to somebody else answers 404, a query under two characters 422, and an unreachable search engine 503.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The groups holding at least one result, in the order the product shows them.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One group.",
                                                "properties": {
                                                    "group": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The key of the group: people, life-events, or entity-type- followed by the entity type."
                                                    },
                                                    "label": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The name of the group, in the language of the account."
                                                    },
                                                    "total": {
                                                        "type": [
                                                            "integer",
                                                            "null"
                                                        ],
                                                        "description": "How many records the group holds in all."
                                                    },
                                                    "next_page": {
                                                        "type": [
                                                            "integer",
                                                            "null"
                                                        ],
                                                        "description": "The page to ask for next, with group, or null on the last page."
                                                    },
                                                    "results": {
                                                        "type": [
                                                            "array",
                                                            "null"
                                                        ],
                                                        "description": "The records of the group on this page, best match first.",
                                                        "items": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "One record.",
                                                            "properties": {
                                                                "type": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "contact, entity or life_event."
                                                                },
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id the record answers to on its own endpoints."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The name the record is listed under."
                                                                },
                                                                "vault": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "The vault the record lives in.",
                                                                    "properties": {
                                                                        "id": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "format": "uuid",
                                                                            "description": "The id of the vault."
                                                                        },
                                                                        "name": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The name of the vault."
                                                                        }
                                                                    }
                                                                },
                                                                "archived": {
                                                                    "type": [
                                                                        "boolean",
                                                                        "null"
                                                                    ],
                                                                    "description": "Whether the record is archived."
                                                                },
                                                                "date": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "For a life event, the day it happened, else null."
                                                                },
                                                                "matched": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "Where the words were found: the label of the value and its text, or null when the name holds them. The text of a sensitive value is always null.",
                                                                    "properties": {
                                                                        "label": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The label of the value, or of the link, the words were found in."
                                                                        },
                                                                        "excerpt": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The text of that value, or null for a sensitive value or a link."
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "group": "people",
                                            "label": "People",
                                            "total": 1,
                                            "next_page": null,
                                            "results": [
                                                {
                                                    "type": "contact",
                                                    "id": "9f1c3a2e-7b4d-4c1a-8e2f-5d6b7a8c9e01",
                                                    "name": "Dwight Schrute",
                                                    "vault": {
                                                        "id": "2c7e9b14-1f3a-4d5e-9a8b-6c4d3e2f1a07",
                                                        "name": "Dunder Mifflin"
                                                    },
                                                    "archived": false,
                                                    "date": null,
                                                    "matched": {
                                                        "label": "Employer",
                                                        "excerpt": "Schrute Farms"
                                                    }
                                                }
                                            ]
                                        }
                                    ],
                                    "meta": {
                                        "query": "farms",
                                        "scope": "vault"
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/life-events": {
            "get": {
                "operationId": "life-events-index",
                "tags": [
                    "Life events"
                ],
                "summary": "List the life events of a vault",
                "description": "List the life events of a vault, the most recent first.\n\nDeleted life events are left out. Narrow the list to one person with contact.\n\nThe value of a sensitive field comes back as null, with is_hidden set to true, unless the key holds the sensitive-fields scope.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the life events live in, named either by the readable name it reports as slug or by its id.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "contact",
                        "in": "query",
                        "required": false,
                        "description": "Only the life events this contact took part in, named by its slug or its id. A contact of another vault answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to answer with.",
                        "schema": {
                            "type": "integer",
                            "default": 1
                        }
                    },
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "How many records one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused.",
                        "schema": {
                            "type": "integer",
                            "default": 25
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of life event objects, and how many there are in all. A vault of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The life events on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One life event.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always life_event. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the life event is called: its title, or the name of its type when it has none."
                                                            },
                                                            "title": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The title written for it, or null."
                                                            },
                                                            "life_event_type": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "Its type. A type deleted since still names the life events recorded as it.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the type, as the life event types endpoints give it."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the type is called."
                                                                    }
                                                                }
                                                            },
                                                            "group": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The group it was recorded on, as an object holding its id and its name, or null when it was not recorded on a group or the group has been deleted."
                                                            },
                                                            "happened_on": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The day it happened, written as a year, a month and a day."
                                                            },
                                                            "duration_in_minutes": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How long it lasted, in minutes, or null."
                                                            },
                                                            "narrative": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What was written about it, or null."
                                                            },
                                                            "location": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Where it happened, or null."
                                                            },
                                                            "participants": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "The contacts who were there, in order. The first is the person the life event is recorded for.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One contact who was there.",
                                                                    "properties": {
                                                                        "id": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "format": "uuid",
                                                                            "description": "The id of the contact."
                                                                        },
                                                                        "name": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The name the contact is shown under."
                                                                        },
                                                                        "position": {
                                                                            "type": [
                                                                                "integer",
                                                                                "null"
                                                                            ],
                                                                            "description": "Where the contact stands in the list, counting from 0."
                                                                        }
                                                                    }
                                                                }
                                                            },
                                                            "fields": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "The values of the custom fields its type asks for. A field left empty is not listed.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One value.",
                                                                    "properties": {
                                                                        "field_id": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The id of the field, which is the key a value is written under when the life event is updated."
                                                                        },
                                                                        "key": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "How the field is named in an import or an export. It is unique inside its group only."
                                                                        },
                                                                        "label": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "What the field is called on the life event."
                                                                        },
                                                                        "type": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The kind of field: text, date, select, address and so on."
                                                                        },
                                                                        "row": {
                                                                            "type": [
                                                                                "integer",
                                                                                "null"
                                                                            ],
                                                                            "description": "For a field inside a repeating group, the id of the repetition it belongs to, which is the id an update keeps that repetition by. Null otherwise."
                                                                        },
                                                                        "value": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The value, written as the contact page shows it. A file field gives the name of the file. Null when hidden."
                                                                        },
                                                                        "is_hidden": {
                                                                            "type": [
                                                                                "boolean",
                                                                                "null"
                                                                            ],
                                                                            "description": "Whether the value was held back because the field is sensitive and the key does not hold the sensitive-fields scope."
                                                                        }
                                                                    }
                                                                }
                                                            },
                                                            "created_from": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Where it was written from: contact, dashboard, group, api, mcp, day, import or module."
                                                            },
                                                            "deleted_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it was deleted, as a count of seconds since 1970, or null."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it was written down, as a count of seconds since 1970."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds since 1970."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The page of the contact the life event is recorded for, whose timeline shows it, in the application. It is the link to give a person."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "life_event",
                                            "id": "7c1e5a92-4b3d-4f80-a6e2-93d0b1c4f857",
                                            "attributes": {
                                                "name": "Lunch at Cugino’s",
                                                "title": "Lunch at Cugino’s",
                                                "life_event_type": {
                                                    "id": "b2f4d6a8-1c3e-4a5b-8d7f-0e9c2b4a6d81",
                                                    "name": "Meal"
                                                },
                                                "group": null,
                                                "happened_on": "2026-10-09",
                                                "duration_in_minutes": 60,
                                                "narrative": "Michael insisted on paying, then asked for the receipt.",
                                                "location": "Scranton",
                                                "participants": [
                                                    {
                                                        "id": "0d3f9b2e-6a41-4c7d-9e58-2b1a7c4e6f90",
                                                        "name": "Pam Beesly",
                                                        "position": 0
                                                    },
                                                    {
                                                        "id": "e5a8c1f3-7b29-4d06-8a4e-5c2d9f1b3a67",
                                                        "name": "Jim Halpert",
                                                        "position": 1
                                                    }
                                                ],
                                                "fields": [
                                                    {
                                                        "field_id": "412",
                                                        "key": "dish",
                                                        "label": "Dish",
                                                        "type": "text",
                                                        "row": null,
                                                        "value": "Chicken parm",
                                                        "is_hidden": false
                                                    }
                                                ],
                                                "created_from": "api",
                                                "deleted_at": null,
                                                "created_at": 1791547200,
                                                "updated_at": 1791547200
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/life-events/7c1e5a92-4b3d-4f80-a6e2-93d0b1c4f857",
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/contacts/pam-beesly"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "life-events-index-query",
                "tags": [
                    "Life events"
                ],
                "summary": "List the life events of a vault",
                "description": "List the life events of a vault, the most recent first.\n\nDeleted life events are left out. Narrow the list to one person with contact.\n\nThe value of a sensitive field comes back as null, with is_hidden set to true, unless the key holds the sensitive-fields scope.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the life events live in, named either by the readable name it reports as slug or by its id.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "contact": {
                                        "type": "string",
                                        "description": "Only the life events this contact took part in, named by its slug or its id. A contact of another vault answers 404."
                                    },
                                    "page": {
                                        "type": "integer",
                                        "default": 1,
                                        "description": "Which page to answer with."
                                    },
                                    "per_page": {
                                        "type": "integer",
                                        "default": 25,
                                        "description": "How many records one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "A page of life event objects, and how many there are in all. A vault of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The life events on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One life event.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always life_event. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the life event is called: its title, or the name of its type when it has none."
                                                            },
                                                            "title": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The title written for it, or null."
                                                            },
                                                            "life_event_type": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "Its type. A type deleted since still names the life events recorded as it.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the type, as the life event types endpoints give it."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the type is called."
                                                                    }
                                                                }
                                                            },
                                                            "group": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The group it was recorded on, as an object holding its id and its name, or null when it was not recorded on a group or the group has been deleted."
                                                            },
                                                            "happened_on": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The day it happened, written as a year, a month and a day."
                                                            },
                                                            "duration_in_minutes": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How long it lasted, in minutes, or null."
                                                            },
                                                            "narrative": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What was written about it, or null."
                                                            },
                                                            "location": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Where it happened, or null."
                                                            },
                                                            "participants": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "The contacts who were there, in order. The first is the person the life event is recorded for.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One contact who was there.",
                                                                    "properties": {
                                                                        "id": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "format": "uuid",
                                                                            "description": "The id of the contact."
                                                                        },
                                                                        "name": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The name the contact is shown under."
                                                                        },
                                                                        "position": {
                                                                            "type": [
                                                                                "integer",
                                                                                "null"
                                                                            ],
                                                                            "description": "Where the contact stands in the list, counting from 0."
                                                                        }
                                                                    }
                                                                }
                                                            },
                                                            "fields": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "The values of the custom fields its type asks for. A field left empty is not listed.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One value.",
                                                                    "properties": {
                                                                        "field_id": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The id of the field, which is the key a value is written under when the life event is updated."
                                                                        },
                                                                        "key": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "How the field is named in an import or an export. It is unique inside its group only."
                                                                        },
                                                                        "label": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "What the field is called on the life event."
                                                                        },
                                                                        "type": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The kind of field: text, date, select, address and so on."
                                                                        },
                                                                        "row": {
                                                                            "type": [
                                                                                "integer",
                                                                                "null"
                                                                            ],
                                                                            "description": "For a field inside a repeating group, the id of the repetition it belongs to, which is the id an update keeps that repetition by. Null otherwise."
                                                                        },
                                                                        "value": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The value, written as the contact page shows it. A file field gives the name of the file. Null when hidden."
                                                                        },
                                                                        "is_hidden": {
                                                                            "type": [
                                                                                "boolean",
                                                                                "null"
                                                                            ],
                                                                            "description": "Whether the value was held back because the field is sensitive and the key does not hold the sensitive-fields scope."
                                                                        }
                                                                    }
                                                                }
                                                            },
                                                            "created_from": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Where it was written from: contact, dashboard, group, api, mcp, day, import or module."
                                                            },
                                                            "deleted_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it was deleted, as a count of seconds since 1970, or null."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it was written down, as a count of seconds since 1970."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds since 1970."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The page of the contact the life event is recorded for, whose timeline shows it, in the application. It is the link to give a person."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "life_event",
                                            "id": "7c1e5a92-4b3d-4f80-a6e2-93d0b1c4f857",
                                            "attributes": {
                                                "name": "Lunch at Cugino’s",
                                                "title": "Lunch at Cugino’s",
                                                "life_event_type": {
                                                    "id": "b2f4d6a8-1c3e-4a5b-8d7f-0e9c2b4a6d81",
                                                    "name": "Meal"
                                                },
                                                "group": null,
                                                "happened_on": "2026-10-09",
                                                "duration_in_minutes": 60,
                                                "narrative": "Michael insisted on paying, then asked for the receipt.",
                                                "location": "Scranton",
                                                "participants": [
                                                    {
                                                        "id": "0d3f9b2e-6a41-4c7d-9e58-2b1a7c4e6f90",
                                                        "name": "Pam Beesly",
                                                        "position": 0
                                                    },
                                                    {
                                                        "id": "e5a8c1f3-7b29-4d06-8a4e-5c2d9f1b3a67",
                                                        "name": "Jim Halpert",
                                                        "position": 1
                                                    }
                                                ],
                                                "fields": [
                                                    {
                                                        "field_id": "412",
                                                        "key": "dish",
                                                        "label": "Dish",
                                                        "type": "text",
                                                        "row": null,
                                                        "value": "Chicken parm",
                                                        "is_hidden": false
                                                    }
                                                ],
                                                "created_from": "api",
                                                "deleted_at": null,
                                                "created_at": 1791547200,
                                                "updated_at": 1791547200
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/life-events/7c1e5a92-4b3d-4f80-a6e2-93d0b1c4f857",
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/contacts/pam-beesly"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "post": {
                "operationId": "life-events-create",
                "tags": [
                    "Life events"
                ],
                "summary": "Record a life event",
                "description": "Write down something that happened. It goes on the timeline of everybody who was there, exactly as if it had been written on the page of the first of them.\n\nThe ids of the custom fields come from GET /life-event-types/{lifeEventType}/fields for a new life event, and from the fields of the life event itself once it exists. A field key cannot stand for an id, since a key is only unique inside its group.\n\nA refusal names what it is about: life_event_type, happened_on, participants, a field under fields, or fields as a whole when a required field is left empty.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the life events live in, named either by the readable name it reports as slug or by its id.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "life_event_type": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "The id of its type, as the life event types endpoints give it. A type switched off cannot be chosen for a new life event and answers 422."
                                    },
                                    "happened_on": {
                                        "type": "string",
                                        "description": "The day it happened, written as a year, a month and a day."
                                    },
                                    "participants": {
                                        "type": "array",
                                        "description": "The contacts who were there, in order, each named by its slug or its id. The first is the person the life event is recorded for. A contact of another vault answers 404."
                                    },
                                    "title": {
                                        "type": "string",
                                        "description": "A title, up to 255 characters. Without one, the life event is called by the name of its type."
                                    },
                                    "narrative": {
                                        "type": "string",
                                        "description": "What happened, up to 65,535 characters."
                                    },
                                    "location": {
                                        "type": "string",
                                        "description": "Where it happened, up to 255 characters."
                                    },
                                    "duration_in_minutes": {
                                        "type": "integer",
                                        "description": "How long it lasted, from 1 to 100,000 minutes."
                                    },
                                    "fields": {
                                        "type": "object",
                                        "description": "The values of the custom fields its type asks for, keyed by field id. A text field takes a string, a select field the id of its choice, a multiple select field a list of them, a date a year, a month and a day. A repeating group takes a list of repetitions, each holding its id when it already exists and its values keyed by the ids of the fields inside the group. A file field cannot be written here and answers 422."
                                    }
                                },
                                "required": [
                                    "life_event_type",
                                    "happened_on",
                                    "participants"
                                ]
                            },
                            "example": {
                                "life_event_type": "b2f4d6a8-1c3e-4a5b-8d7f-0e9c2b4a6d81",
                                "happened_on": "2026-10-09",
                                "participants": [
                                    "pam-beesly",
                                    "jim-halpert"
                                ],
                                "title": "Lunch at Cugino’s",
                                "narrative": "Michael insisted on paying, then asked for the receipt.",
                                "location": "Scranton",
                                "duration_in_minutes": 60,
                                "fields": {
                                    "412": "Chicken parm"
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The life event object that was recorded.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The life event.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always life_event. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the life event is called: its title, or the name of its type when it has none."
                                                        },
                                                        "title": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The title written for it, or null."
                                                        },
                                                        "life_event_type": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "Its type. A type deleted since still names the life events recorded as it.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the type, as the life event types endpoints give it."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What the type is called."
                                                                }
                                                            }
                                                        },
                                                        "group": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The group it was recorded on, as an object holding its id and its name, or null when it was not recorded on a group or the group has been deleted."
                                                        },
                                                        "happened_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day it happened, written as a year, a month and a day."
                                                        },
                                                        "duration_in_minutes": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How long it lasted, in minutes, or null."
                                                        },
                                                        "narrative": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What was written about it, or null."
                                                        },
                                                        "location": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where it happened, or null."
                                                        },
                                                        "participants": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The contacts who were there, in order. The first is the person the life event is recorded for.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One contact who was there.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the contact."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name the contact is shown under."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Where the contact stands in the list, counting from 0."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "fields": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The values of the custom fields its type asks for. A field left empty is not listed.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One value.",
                                                                "properties": {
                                                                    "field_id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The id of the field, which is the key a value is written under when the life event is updated."
                                                                    },
                                                                    "key": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "How the field is named in an import or an export. It is unique inside its group only."
                                                                    },
                                                                    "label": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field is called on the life event."
                                                                    },
                                                                    "type": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The kind of field: text, date, select, address and so on."
                                                                    },
                                                                    "row": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "For a field inside a repeating group, the id of the repetition it belongs to, which is the id an update keeps that repetition by. Null otherwise."
                                                                    },
                                                                    "value": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The value, written as the contact page shows it. A file field gives the name of the file. Null when hidden."
                                                                    },
                                                                    "is_hidden": {
                                                                        "type": [
                                                                            "boolean",
                                                                            "null"
                                                                        ],
                                                                        "description": "Whether the value was held back because the field is sensitive and the key does not hold the sensitive-fields scope."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "created_from": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where it was written from: contact, dashboard, group, api, mcp, day, import or module."
                                                        },
                                                        "deleted_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it was deleted, as a count of seconds since 1970, or null."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it was written down, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds since 1970."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The page of the contact the life event is recorded for, whose timeline shows it, in the application. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "life_event",
                                        "id": "7c1e5a92-4b3d-4f80-a6e2-93d0b1c4f857",
                                        "attributes": {
                                            "name": "Lunch at Cugino’s",
                                            "title": "Lunch at Cugino’s",
                                            "life_event_type": {
                                                "id": "b2f4d6a8-1c3e-4a5b-8d7f-0e9c2b4a6d81",
                                                "name": "Meal"
                                            },
                                            "group": null,
                                            "happened_on": "2026-10-09",
                                            "duration_in_minutes": 60,
                                            "narrative": "Michael insisted on paying, then asked for the receipt.",
                                            "location": "Scranton",
                                            "participants": [
                                                {
                                                    "id": "0d3f9b2e-6a41-4c7d-9e58-2b1a7c4e6f90",
                                                    "name": "Pam Beesly",
                                                    "position": 0
                                                },
                                                {
                                                    "id": "e5a8c1f3-7b29-4d06-8a4e-5c2d9f1b3a67",
                                                    "name": "Jim Halpert",
                                                    "position": 1
                                                }
                                            ],
                                            "fields": [
                                                {
                                                    "field_id": "412",
                                                    "key": "dish",
                                                    "label": "Dish",
                                                    "type": "text",
                                                    "row": null,
                                                    "value": "Chicken parm",
                                                    "is_hidden": false
                                                }
                                            ],
                                            "created_from": "api",
                                            "deleted_at": null,
                                            "created_at": 1791547200,
                                            "updated_at": 1791547200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/life-events/7c1e5a92-4b3d-4f80-a6e2-93d0b1c4f857",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/contacts/pam-beesly"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/life-events/{lifeEvent}": {
            "get": {
                "operationId": "life-events-show",
                "tags": [
                    "Life events"
                ],
                "summary": "Get a life event",
                "description": "Retrieve one life event, with who was there and the values of its custom fields.\n\nThe value of a sensitive field comes back as null, with is_hidden set to true, unless the key holds the sensitive-fields scope.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the life events live in, named either by the readable name it reports as slug or by its id.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "lifeEvent",
                        "in": "path",
                        "required": true,
                        "description": "The id of the life event. One addressed through the wrong vault, or belonging to another account, answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A life event object. One of another account or vault answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The life event.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always life_event. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the life event is called: its title, or the name of its type when it has none."
                                                        },
                                                        "title": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The title written for it, or null."
                                                        },
                                                        "life_event_type": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "Its type. A type deleted since still names the life events recorded as it.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the type, as the life event types endpoints give it."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What the type is called."
                                                                }
                                                            }
                                                        },
                                                        "group": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The group it was recorded on, as an object holding its id and its name, or null when it was not recorded on a group or the group has been deleted."
                                                        },
                                                        "happened_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day it happened, written as a year, a month and a day."
                                                        },
                                                        "duration_in_minutes": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How long it lasted, in minutes, or null."
                                                        },
                                                        "narrative": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What was written about it, or null."
                                                        },
                                                        "location": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where it happened, or null."
                                                        },
                                                        "participants": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The contacts who were there, in order. The first is the person the life event is recorded for.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One contact who was there.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the contact."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name the contact is shown under."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Where the contact stands in the list, counting from 0."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "fields": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The values of the custom fields its type asks for. A field left empty is not listed.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One value.",
                                                                "properties": {
                                                                    "field_id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The id of the field, which is the key a value is written under when the life event is updated."
                                                                    },
                                                                    "key": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "How the field is named in an import or an export. It is unique inside its group only."
                                                                    },
                                                                    "label": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field is called on the life event."
                                                                    },
                                                                    "type": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The kind of field: text, date, select, address and so on."
                                                                    },
                                                                    "row": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "For a field inside a repeating group, the id of the repetition it belongs to, which is the id an update keeps that repetition by. Null otherwise."
                                                                    },
                                                                    "value": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The value, written as the contact page shows it. A file field gives the name of the file. Null when hidden."
                                                                    },
                                                                    "is_hidden": {
                                                                        "type": [
                                                                            "boolean",
                                                                            "null"
                                                                        ],
                                                                        "description": "Whether the value was held back because the field is sensitive and the key does not hold the sensitive-fields scope."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "created_from": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where it was written from: contact, dashboard, group, api, mcp, day, import or module."
                                                        },
                                                        "deleted_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it was deleted, as a count of seconds since 1970, or null."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it was written down, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds since 1970."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The page of the contact the life event is recorded for, whose timeline shows it, in the application. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "life_event",
                                        "id": "7c1e5a92-4b3d-4f80-a6e2-93d0b1c4f857",
                                        "attributes": {
                                            "name": "Lunch at Cugino’s",
                                            "title": "Lunch at Cugino’s",
                                            "life_event_type": {
                                                "id": "b2f4d6a8-1c3e-4a5b-8d7f-0e9c2b4a6d81",
                                                "name": "Meal"
                                            },
                                            "group": null,
                                            "happened_on": "2026-10-09",
                                            "duration_in_minutes": 60,
                                            "narrative": "Michael insisted on paying, then asked for the receipt.",
                                            "location": "Scranton",
                                            "participants": [
                                                {
                                                    "id": "0d3f9b2e-6a41-4c7d-9e58-2b1a7c4e6f90",
                                                    "name": "Pam Beesly",
                                                    "position": 0
                                                },
                                                {
                                                    "id": "e5a8c1f3-7b29-4d06-8a4e-5c2d9f1b3a67",
                                                    "name": "Jim Halpert",
                                                    "position": 1
                                                }
                                            ],
                                            "fields": [
                                                {
                                                    "field_id": "412",
                                                    "key": "dish",
                                                    "label": "Dish",
                                                    "type": "text",
                                                    "row": null,
                                                    "value": "Chicken parm",
                                                    "is_hidden": false
                                                }
                                            ],
                                            "created_from": "api",
                                            "deleted_at": null,
                                            "created_at": 1791547200,
                                            "updated_at": 1791547200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/life-events/7c1e5a92-4b3d-4f80-a6e2-93d0b1c4f857",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/contacts/pam-beesly"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "life-events-show-query",
                "tags": [
                    "Life events"
                ],
                "summary": "Get a life event",
                "description": "Retrieve one life event, with who was there and the values of its custom fields.\n\nThe value of a sensitive field comes back as null, with is_hidden set to true, unless the key holds the sensitive-fields scope.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the life events live in, named either by the readable name it reports as slug or by its id.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "lifeEvent",
                        "in": "path",
                        "required": true,
                        "description": "The id of the life event. One addressed through the wrong vault, or belonging to another account, answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A life event object. One of another account or vault answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The life event.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always life_event. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the life event is called: its title, or the name of its type when it has none."
                                                        },
                                                        "title": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The title written for it, or null."
                                                        },
                                                        "life_event_type": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "Its type. A type deleted since still names the life events recorded as it.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the type, as the life event types endpoints give it."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What the type is called."
                                                                }
                                                            }
                                                        },
                                                        "group": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The group it was recorded on, as an object holding its id and its name, or null when it was not recorded on a group or the group has been deleted."
                                                        },
                                                        "happened_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day it happened, written as a year, a month and a day."
                                                        },
                                                        "duration_in_minutes": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How long it lasted, in minutes, or null."
                                                        },
                                                        "narrative": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What was written about it, or null."
                                                        },
                                                        "location": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where it happened, or null."
                                                        },
                                                        "participants": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The contacts who were there, in order. The first is the person the life event is recorded for.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One contact who was there.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the contact."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name the contact is shown under."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Where the contact stands in the list, counting from 0."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "fields": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The values of the custom fields its type asks for. A field left empty is not listed.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One value.",
                                                                "properties": {
                                                                    "field_id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The id of the field, which is the key a value is written under when the life event is updated."
                                                                    },
                                                                    "key": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "How the field is named in an import or an export. It is unique inside its group only."
                                                                    },
                                                                    "label": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field is called on the life event."
                                                                    },
                                                                    "type": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The kind of field: text, date, select, address and so on."
                                                                    },
                                                                    "row": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "For a field inside a repeating group, the id of the repetition it belongs to, which is the id an update keeps that repetition by. Null otherwise."
                                                                    },
                                                                    "value": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The value, written as the contact page shows it. A file field gives the name of the file. Null when hidden."
                                                                    },
                                                                    "is_hidden": {
                                                                        "type": [
                                                                            "boolean",
                                                                            "null"
                                                                        ],
                                                                        "description": "Whether the value was held back because the field is sensitive and the key does not hold the sensitive-fields scope."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "created_from": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where it was written from: contact, dashboard, group, api, mcp, day, import or module."
                                                        },
                                                        "deleted_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it was deleted, as a count of seconds since 1970, or null."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it was written down, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds since 1970."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The page of the contact the life event is recorded for, whose timeline shows it, in the application. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "life_event",
                                        "id": "7c1e5a92-4b3d-4f80-a6e2-93d0b1c4f857",
                                        "attributes": {
                                            "name": "Lunch at Cugino’s",
                                            "title": "Lunch at Cugino’s",
                                            "life_event_type": {
                                                "id": "b2f4d6a8-1c3e-4a5b-8d7f-0e9c2b4a6d81",
                                                "name": "Meal"
                                            },
                                            "group": null,
                                            "happened_on": "2026-10-09",
                                            "duration_in_minutes": 60,
                                            "narrative": "Michael insisted on paying, then asked for the receipt.",
                                            "location": "Scranton",
                                            "participants": [
                                                {
                                                    "id": "0d3f9b2e-6a41-4c7d-9e58-2b1a7c4e6f90",
                                                    "name": "Pam Beesly",
                                                    "position": 0
                                                },
                                                {
                                                    "id": "e5a8c1f3-7b29-4d06-8a4e-5c2d9f1b3a67",
                                                    "name": "Jim Halpert",
                                                    "position": 1
                                                }
                                            ],
                                            "fields": [
                                                {
                                                    "field_id": "412",
                                                    "key": "dish",
                                                    "label": "Dish",
                                                    "type": "text",
                                                    "row": null,
                                                    "value": "Chicken parm",
                                                    "is_hidden": false
                                                }
                                            ],
                                            "created_from": "api",
                                            "deleted_at": null,
                                            "created_at": 1791547200,
                                            "updated_at": 1791547200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/life-events/7c1e5a92-4b3d-4f80-a6e2-93d0b1c4f857",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/contacts/pam-beesly"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "put": {
                "operationId": "life-events-update",
                "tags": [
                    "Life events"
                ],
                "summary": "Change a life event",
                "description": "Change what a life event says: its type, its date, its text and who was there.\n\nAn attribute left out keeps its value. The title, the narrative, the location and the duration are cleared by null, and the type, the date and the participants cannot be null. Leave fields out and every custom field value stays as it is. Send fields and it replaces the whole set, so a field missing from it is cleared, and a repetition sent without its id replaces the one it stood for. A sensitive field the key cannot see keeps its value unless it is sent.\n\nThe first participant has to stay the person the life event is recorded for, and anything else answers 422. To record it for somebody else, delete it and record it again.\n\nA life event keeps the version of its type's fields it was written with while its type stays the same. Choosing another type moves it to that type's fields and lets the old values go.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the life events live in, named either by the readable name it reports as slug or by its id.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "lifeEvent",
                        "in": "path",
                        "required": true,
                        "description": "The id of the life event. One addressed through the wrong vault, or belonging to another account, answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "life_event_type": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "The id of its type, as the life event types endpoints give it. A type switched off cannot be chosen for a new life event and answers 422."
                                    },
                                    "happened_on": {
                                        "type": "string",
                                        "description": "The day it happened, written as a year, a month and a day."
                                    },
                                    "participants": {
                                        "type": "array",
                                        "description": "The contacts who were there, in order, each named by its slug or its id. The first is the person the life event is recorded for. A contact of another vault answers 404."
                                    },
                                    "title": {
                                        "type": "string",
                                        "description": "A title, up to 255 characters. Without one, the life event is called by the name of its type."
                                    },
                                    "narrative": {
                                        "type": "string",
                                        "description": "What happened, up to 65,535 characters."
                                    },
                                    "location": {
                                        "type": "string",
                                        "description": "Where it happened, up to 255 characters."
                                    },
                                    "duration_in_minutes": {
                                        "type": "integer",
                                        "description": "How long it lasted, from 1 to 100,000 minutes."
                                    },
                                    "fields": {
                                        "type": "object",
                                        "description": "The values of the custom fields its type asks for, keyed by field id. A text field takes a string, a select field the id of its choice, a multiple select field a list of them, a date a year, a month and a day. A repeating group takes a list of repetitions, each holding its id when it already exists and its values keyed by the ids of the fields inside the group. A file field cannot be written here and answers 422."
                                    }
                                }
                            },
                            "example": {
                                "life_event_type": "b2f4d6a8-1c3e-4a5b-8d7f-0e9c2b4a6d81",
                                "happened_on": "2026-10-09",
                                "participants": [
                                    "pam-beesly",
                                    "jim-halpert"
                                ],
                                "title": "Lunch at Cugino’s",
                                "narrative": "Michael insisted on paying, then asked for the receipt.",
                                "location": "Scranton",
                                "duration_in_minutes": 60,
                                "fields": {
                                    "412": "Chicken parm"
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The life event object as it stands now.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The life event.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always life_event. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the life event is called: its title, or the name of its type when it has none."
                                                        },
                                                        "title": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The title written for it, or null."
                                                        },
                                                        "life_event_type": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "Its type. A type deleted since still names the life events recorded as it.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the type, as the life event types endpoints give it."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What the type is called."
                                                                }
                                                            }
                                                        },
                                                        "group": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The group it was recorded on, as an object holding its id and its name, or null when it was not recorded on a group or the group has been deleted."
                                                        },
                                                        "happened_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day it happened, written as a year, a month and a day."
                                                        },
                                                        "duration_in_minutes": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How long it lasted, in minutes, or null."
                                                        },
                                                        "narrative": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What was written about it, or null."
                                                        },
                                                        "location": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where it happened, or null."
                                                        },
                                                        "participants": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The contacts who were there, in order. The first is the person the life event is recorded for.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One contact who was there.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the contact."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name the contact is shown under."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Where the contact stands in the list, counting from 0."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "fields": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The values of the custom fields its type asks for. A field left empty is not listed.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One value.",
                                                                "properties": {
                                                                    "field_id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The id of the field, which is the key a value is written under when the life event is updated."
                                                                    },
                                                                    "key": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "How the field is named in an import or an export. It is unique inside its group only."
                                                                    },
                                                                    "label": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field is called on the life event."
                                                                    },
                                                                    "type": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The kind of field: text, date, select, address and so on."
                                                                    },
                                                                    "row": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "For a field inside a repeating group, the id of the repetition it belongs to, which is the id an update keeps that repetition by. Null otherwise."
                                                                    },
                                                                    "value": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The value, written as the contact page shows it. A file field gives the name of the file. Null when hidden."
                                                                    },
                                                                    "is_hidden": {
                                                                        "type": [
                                                                            "boolean",
                                                                            "null"
                                                                        ],
                                                                        "description": "Whether the value was held back because the field is sensitive and the key does not hold the sensitive-fields scope."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "created_from": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where it was written from: contact, dashboard, group, api, mcp, day, import or module."
                                                        },
                                                        "deleted_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it was deleted, as a count of seconds since 1970, or null."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it was written down, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds since 1970."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The page of the contact the life event is recorded for, whose timeline shows it, in the application. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "life_event",
                                        "id": "7c1e5a92-4b3d-4f80-a6e2-93d0b1c4f857",
                                        "attributes": {
                                            "name": "Lunch at Cugino’s",
                                            "title": "Lunch at Cugino’s",
                                            "life_event_type": {
                                                "id": "b2f4d6a8-1c3e-4a5b-8d7f-0e9c2b4a6d81",
                                                "name": "Meal"
                                            },
                                            "group": null,
                                            "happened_on": "2026-10-09",
                                            "duration_in_minutes": 60,
                                            "narrative": "Michael insisted on paying, then asked for the receipt.",
                                            "location": "Scranton",
                                            "participants": [
                                                {
                                                    "id": "0d3f9b2e-6a41-4c7d-9e58-2b1a7c4e6f90",
                                                    "name": "Pam Beesly",
                                                    "position": 0
                                                },
                                                {
                                                    "id": "e5a8c1f3-7b29-4d06-8a4e-5c2d9f1b3a67",
                                                    "name": "Jim Halpert",
                                                    "position": 1
                                                }
                                            ],
                                            "fields": [
                                                {
                                                    "field_id": "412",
                                                    "key": "dish",
                                                    "label": "Dish",
                                                    "type": "text",
                                                    "row": null,
                                                    "value": "Chicken parm",
                                                    "is_hidden": false
                                                }
                                            ],
                                            "created_from": "api",
                                            "deleted_at": null,
                                            "created_at": 1791547200,
                                            "updated_at": 1791547200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/life-events/7c1e5a92-4b3d-4f80-a6e2-93d0b1c4f857",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/contacts/pam-beesly"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "delete": {
                "operationId": "life-events-destroy",
                "tags": [
                    "Life events"
                ],
                "summary": "Delete a life event",
                "description": "Take a life event off the timeline of everybody who was there. It can be restored.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the life events live in, named either by the readable name it reports as slug or by its id.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "lifeEvent",
                        "in": "path",
                        "required": true,
                        "description": "The id of the life event. One addressed through the wrong vault, or belonging to another account, answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Nothing at all."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/life-events/{lifeEvent}/restoration": {
            "put": {
                "operationId": "life-events-restoration-update",
                "tags": [
                    "Life events"
                ],
                "summary": "Restore a life event",
                "description": "Put a deleted life event back on the timeline of everybody who was there.\n\nA life event that is not deleted answers 404.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the life events live in, named either by the readable name it reports as slug or by its id.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "lifeEvent",
                        "in": "path",
                        "required": true,
                        "description": "The id of the life event. One addressed through the wrong vault, or belonging to another account, answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The life event object, restored.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The life event.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always life_event. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the life event is called: its title, or the name of its type when it has none."
                                                        },
                                                        "title": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The title written for it, or null."
                                                        },
                                                        "life_event_type": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "Its type. A type deleted since still names the life events recorded as it.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the type, as the life event types endpoints give it."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What the type is called."
                                                                }
                                                            }
                                                        },
                                                        "group": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The group it was recorded on, as an object holding its id and its name, or null when it was not recorded on a group or the group has been deleted."
                                                        },
                                                        "happened_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day it happened, written as a year, a month and a day."
                                                        },
                                                        "duration_in_minutes": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How long it lasted, in minutes, or null."
                                                        },
                                                        "narrative": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What was written about it, or null."
                                                        },
                                                        "location": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where it happened, or null."
                                                        },
                                                        "participants": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The contacts who were there, in order. The first is the person the life event is recorded for.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One contact who was there.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the contact."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name the contact is shown under."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Where the contact stands in the list, counting from 0."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "fields": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The values of the custom fields its type asks for. A field left empty is not listed.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One value.",
                                                                "properties": {
                                                                    "field_id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The id of the field, which is the key a value is written under when the life event is updated."
                                                                    },
                                                                    "key": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "How the field is named in an import or an export. It is unique inside its group only."
                                                                    },
                                                                    "label": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field is called on the life event."
                                                                    },
                                                                    "type": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The kind of field: text, date, select, address and so on."
                                                                    },
                                                                    "row": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "For a field inside a repeating group, the id of the repetition it belongs to, which is the id an update keeps that repetition by. Null otherwise."
                                                                    },
                                                                    "value": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The value, written as the contact page shows it. A file field gives the name of the file. Null when hidden."
                                                                    },
                                                                    "is_hidden": {
                                                                        "type": [
                                                                            "boolean",
                                                                            "null"
                                                                        ],
                                                                        "description": "Whether the value was held back because the field is sensitive and the key does not hold the sensitive-fields scope."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "created_from": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where it was written from: contact, dashboard, group, api, mcp, day, import or module."
                                                        },
                                                        "deleted_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it was deleted, as a count of seconds since 1970, or null."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it was written down, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds since 1970."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The page of the contact the life event is recorded for, whose timeline shows it, in the application. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "life_event",
                                        "id": "7c1e5a92-4b3d-4f80-a6e2-93d0b1c4f857",
                                        "attributes": {
                                            "name": "Lunch at Cugino’s",
                                            "title": "Lunch at Cugino’s",
                                            "life_event_type": {
                                                "id": "b2f4d6a8-1c3e-4a5b-8d7f-0e9c2b4a6d81",
                                                "name": "Meal"
                                            },
                                            "group": null,
                                            "happened_on": "2026-10-09",
                                            "duration_in_minutes": 60,
                                            "narrative": "Michael insisted on paying, then asked for the receipt.",
                                            "location": "Scranton",
                                            "participants": [
                                                {
                                                    "id": "0d3f9b2e-6a41-4c7d-9e58-2b1a7c4e6f90",
                                                    "name": "Pam Beesly",
                                                    "position": 0
                                                },
                                                {
                                                    "id": "e5a8c1f3-7b29-4d06-8a4e-5c2d9f1b3a67",
                                                    "name": "Jim Halpert",
                                                    "position": 1
                                                }
                                            ],
                                            "fields": [
                                                {
                                                    "field_id": "412",
                                                    "key": "dish",
                                                    "label": "Dish",
                                                    "type": "text",
                                                    "row": null,
                                                    "value": "Chicken parm",
                                                    "is_hidden": false
                                                }
                                            ],
                                            "created_from": "api",
                                            "deleted_at": null,
                                            "created_at": 1791547200,
                                            "updated_at": 1791547200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/life-events/7c1e5a92-4b3d-4f80-a6e2-93d0b1c4f857",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/contacts/pam-beesly"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/contacts/{contact}/relationships": {
            "get": {
                "operationId": "relationships-index",
                "tags": [
                    "Relationships"
                ],
                "summary": "List a contact's relationships",
                "description": "List every relationship one contact is part of, whichever side they are on.\n\nRead contact_a and contact_b to tell which side the contact is on. The other one is the person they are linked to.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault both people live in, named either by the readable name it reports as slug or by its id.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "contact",
                        "in": "path",
                        "required": true,
                        "description": "One of the two people, named either by their slug or by their id. A contact addressed through the wrong vault answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to answer with.",
                        "schema": {
                            "type": "integer",
                            "default": 1
                        }
                    },
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "How many records one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused.",
                        "schema": {
                            "type": "integer",
                            "default": 25
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of relationship objects, and how many there are in all.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The relationships on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One relationship.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always relationship. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "relationship_type": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "What the link is.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the relationship type."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name of the relationship type."
                                                                    },
                                                                    "is_symmetric": {
                                                                        "type": [
                                                                            "boolean",
                                                                            "null"
                                                                        ],
                                                                        "description": "True when both people hold the same role, as partners do."
                                                                    }
                                                                }
                                                            },
                                                            "contact_a": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The person holding role_a.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the contact."
                                                                    },
                                                                    "slug": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The readable name of the contact, which addresses it as well as its id."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name of the contact, as it is shown."
                                                                    },
                                                                    "is_partial": {
                                                                        "type": [
                                                                            "boolean",
                                                                            "null"
                                                                        ],
                                                                        "description": "True for somebody who exists only through a relationship and has no record of their own."
                                                                    },
                                                                    "role": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The role this person holds, which is the type's role_a."
                                                                    }
                                                                }
                                                            },
                                                            "contact_b": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The person holding role_b.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the contact."
                                                                    },
                                                                    "slug": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The readable name of the contact, which addresses it as well as its id."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name of the contact, as it is shown."
                                                                    },
                                                                    "is_partial": {
                                                                        "type": [
                                                                            "boolean",
                                                                            "null"
                                                                        ],
                                                                        "description": "True for somebody who exists only through a relationship and has no record of their own."
                                                                    },
                                                                    "role": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The role this person holds, which is the type's role_b."
                                                                    }
                                                                }
                                                            },
                                                            "status": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "current or ended."
                                                            },
                                                            "started_on": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "When it started, written as a year, a month and a day, or null."
                                                            },
                                                            "ended_on": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "When it ended, or null. Always null while the relationship is current."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the relationship was recorded, as a count of seconds since 1970."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "relationship",
                                            "id": "7c1e9a42-5b3d-4f60-a8e2-0d94b6c3f185",
                                            "attributes": {
                                                "relationship_type": {
                                                    "id": "b52f0d7e-1c84-4a39-9e6b-3f7a20c5d816",
                                                    "name": "Partner",
                                                    "is_symmetric": true
                                                },
                                                "contact_a": {
                                                    "id": "2d6b8f13-9a07-4c5e-b1f4-6e3a90d2c748",
                                                    "slug": "jim-halpert",
                                                    "name": "Jim Halpert",
                                                    "is_partial": false,
                                                    "role": "partner"
                                                },
                                                "contact_b": {
                                                    "id": "e8a41c06-7f25-4b93-8d0e-52c9b7f1a364",
                                                    "slug": "pam-beesly",
                                                    "name": "Pam Beesly",
                                                    "is_partial": false,
                                                    "role": "partner"
                                                },
                                                "status": "current",
                                                "started_on": "2007-05-10",
                                                "ended_on": null,
                                                "created_at": 1790380800,
                                                "updated_at": 1790380800
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/jim-halpert/relationships/7c1e9a42-5b3d-4f60-a8e2-0d94b6c3f185"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "relationships-index-query",
                "tags": [
                    "Relationships"
                ],
                "summary": "List a contact's relationships",
                "description": "List every relationship one contact is part of, whichever side they are on.\n\nRead contact_a and contact_b to tell which side the contact is on. The other one is the person they are linked to.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault both people live in, named either by the readable name it reports as slug or by its id.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "contact",
                        "in": "path",
                        "required": true,
                        "description": "One of the two people, named either by their slug or by their id. A contact addressed through the wrong vault answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "page": {
                                        "type": "integer",
                                        "default": 1,
                                        "description": "Which page to answer with."
                                    },
                                    "per_page": {
                                        "type": "integer",
                                        "default": 25,
                                        "description": "How many records one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "A page of relationship objects, and how many there are in all.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The relationships on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One relationship.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always relationship. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "relationship_type": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "What the link is.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the relationship type."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name of the relationship type."
                                                                    },
                                                                    "is_symmetric": {
                                                                        "type": [
                                                                            "boolean",
                                                                            "null"
                                                                        ],
                                                                        "description": "True when both people hold the same role, as partners do."
                                                                    }
                                                                }
                                                            },
                                                            "contact_a": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The person holding role_a.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the contact."
                                                                    },
                                                                    "slug": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The readable name of the contact, which addresses it as well as its id."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name of the contact, as it is shown."
                                                                    },
                                                                    "is_partial": {
                                                                        "type": [
                                                                            "boolean",
                                                                            "null"
                                                                        ],
                                                                        "description": "True for somebody who exists only through a relationship and has no record of their own."
                                                                    },
                                                                    "role": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The role this person holds, which is the type's role_a."
                                                                    }
                                                                }
                                                            },
                                                            "contact_b": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The person holding role_b.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the contact."
                                                                    },
                                                                    "slug": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The readable name of the contact, which addresses it as well as its id."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name of the contact, as it is shown."
                                                                    },
                                                                    "is_partial": {
                                                                        "type": [
                                                                            "boolean",
                                                                            "null"
                                                                        ],
                                                                        "description": "True for somebody who exists only through a relationship and has no record of their own."
                                                                    },
                                                                    "role": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The role this person holds, which is the type's role_b."
                                                                    }
                                                                }
                                                            },
                                                            "status": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "current or ended."
                                                            },
                                                            "started_on": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "When it started, written as a year, a month and a day, or null."
                                                            },
                                                            "ended_on": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "When it ended, or null. Always null while the relationship is current."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the relationship was recorded, as a count of seconds since 1970."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "relationship",
                                            "id": "7c1e9a42-5b3d-4f60-a8e2-0d94b6c3f185",
                                            "attributes": {
                                                "relationship_type": {
                                                    "id": "b52f0d7e-1c84-4a39-9e6b-3f7a20c5d816",
                                                    "name": "Partner",
                                                    "is_symmetric": true
                                                },
                                                "contact_a": {
                                                    "id": "2d6b8f13-9a07-4c5e-b1f4-6e3a90d2c748",
                                                    "slug": "jim-halpert",
                                                    "name": "Jim Halpert",
                                                    "is_partial": false,
                                                    "role": "partner"
                                                },
                                                "contact_b": {
                                                    "id": "e8a41c06-7f25-4b93-8d0e-52c9b7f1a364",
                                                    "slug": "pam-beesly",
                                                    "name": "Pam Beesly",
                                                    "is_partial": false,
                                                    "role": "partner"
                                                },
                                                "status": "current",
                                                "started_on": "2007-05-10",
                                                "ended_on": null,
                                                "created_at": 1790380800,
                                                "updated_at": 1790380800
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/jim-halpert/relationships/7c1e9a42-5b3d-4f60-a8e2-0d94b6c3f185"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "post": {
                "operationId": "relationships-create",
                "tags": [
                    "Relationships"
                ],
                "summary": "Add a relationship",
                "description": "Link a contact to somebody else in the same vault.\n\nThe other person is an existing contact named by other_contact, somebody new named by first_name, or, when you send neither, somebody whose name is unknown. Somebody new has no record of their own unless creates_record is true.\n\nLinking somebody to themselves, using a type that is switched off, or making somebody their own ancestor answers 422, naming other_contact or relationship_type.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault both people live in, named either by the readable name it reports as slug or by its id.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "contact",
                        "in": "path",
                        "required": true,
                        "description": "One of the two people, named either by their slug or by their id. A contact addressed through the wrong vault answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "relationship_type": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "The id of a relationship type of your account. A type that is switched off answers 422."
                                    },
                                    "other_contact": {
                                        "type": "string",
                                        "description": "The other person, a contact of the same vault, named by their slug or their id. Not allowed with first_name or last_name."
                                    },
                                    "first_name": {
                                        "type": "string",
                                        "description": "The first name of somebody who has no record of their own. Up to 255 characters."
                                    },
                                    "last_name": {
                                        "type": "string",
                                        "description": "Their last name. Needs first_name."
                                    },
                                    "creates_record": {
                                        "type": "boolean",
                                        "description": "True to give that person a full record of their own in the vault."
                                    },
                                    "holds_role_a": {
                                        "type": "boolean",
                                        "description": "Whether the contact in the address holds role_a and the other person role_b. For a parent and child type, true says the contact is the parent. Ignored for a symmetric type. True when left out."
                                    }
                                },
                                "required": [
                                    "relationship_type"
                                ]
                            },
                            "example": {
                                "relationship_type": "b52f0d7e-1c84-4a39-9e6b-3f7a20c5d816",
                                "other_contact": "pam-beesly",
                                "first_name": "Cece",
                                "last_name": "Halpert",
                                "creates_record": false,
                                "holds_role_a": true
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The relationship object that was added.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The relationship.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always relationship. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "relationship_type": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "What the link is.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the relationship type."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The name of the relationship type."
                                                                },
                                                                "is_symmetric": {
                                                                    "type": [
                                                                        "boolean",
                                                                        "null"
                                                                    ],
                                                                    "description": "True when both people hold the same role, as partners do."
                                                                }
                                                            }
                                                        },
                                                        "contact_a": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The person holding role_a.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the contact."
                                                                },
                                                                "slug": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The readable name of the contact, which addresses it as well as its id."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The name of the contact, as it is shown."
                                                                },
                                                                "is_partial": {
                                                                    "type": [
                                                                        "boolean",
                                                                        "null"
                                                                    ],
                                                                    "description": "True for somebody who exists only through a relationship and has no record of their own."
                                                                },
                                                                "role": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The role this person holds, which is the type's role_a."
                                                                }
                                                            }
                                                        },
                                                        "contact_b": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The person holding role_b.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the contact."
                                                                },
                                                                "slug": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The readable name of the contact, which addresses it as well as its id."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The name of the contact, as it is shown."
                                                                },
                                                                "is_partial": {
                                                                    "type": [
                                                                        "boolean",
                                                                        "null"
                                                                    ],
                                                                    "description": "True for somebody who exists only through a relationship and has no record of their own."
                                                                },
                                                                "role": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The role this person holds, which is the type's role_b."
                                                                }
                                                            }
                                                        },
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "current or ended."
                                                        },
                                                        "started_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "When it started, written as a year, a month and a day, or null."
                                                        },
                                                        "ended_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "When it ended, or null. Always null while the relationship is current."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the relationship was recorded, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "relationship",
                                        "id": "7c1e9a42-5b3d-4f60-a8e2-0d94b6c3f185",
                                        "attributes": {
                                            "relationship_type": {
                                                "id": "b52f0d7e-1c84-4a39-9e6b-3f7a20c5d816",
                                                "name": "Partner",
                                                "is_symmetric": true
                                            },
                                            "contact_a": {
                                                "id": "2d6b8f13-9a07-4c5e-b1f4-6e3a90d2c748",
                                                "slug": "jim-halpert",
                                                "name": "Jim Halpert",
                                                "is_partial": false,
                                                "role": "partner"
                                            },
                                            "contact_b": {
                                                "id": "e8a41c06-7f25-4b93-8d0e-52c9b7f1a364",
                                                "slug": "pam-beesly",
                                                "name": "Pam Beesly",
                                                "is_partial": false,
                                                "role": "partner"
                                            },
                                            "status": "current",
                                            "started_on": "2007-05-10",
                                            "ended_on": null,
                                            "created_at": 1790380800,
                                            "updated_at": 1790380800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/jim-halpert/relationships/7c1e9a42-5b3d-4f60-a8e2-0d94b6c3f185"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/contacts/{contact}/relationships/{relationship}": {
            "get": {
                "operationId": "relationships-show",
                "tags": [
                    "Relationships"
                ],
                "summary": "Get a relationship",
                "description": "Retrieve one relationship through either of its two people.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault both people live in, named either by the readable name it reports as slug or by its id.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "contact",
                        "in": "path",
                        "required": true,
                        "description": "One of the two people, named either by their slug or by their id. A contact addressed through the wrong vault answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "relationship",
                        "in": "path",
                        "required": true,
                        "description": "The id of the relationship. It is reached through either of its two people, and through anybody else answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A relationship object.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The relationship.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always relationship. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "relationship_type": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "What the link is.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the relationship type."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The name of the relationship type."
                                                                },
                                                                "is_symmetric": {
                                                                    "type": [
                                                                        "boolean",
                                                                        "null"
                                                                    ],
                                                                    "description": "True when both people hold the same role, as partners do."
                                                                }
                                                            }
                                                        },
                                                        "contact_a": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The person holding role_a.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the contact."
                                                                },
                                                                "slug": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The readable name of the contact, which addresses it as well as its id."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The name of the contact, as it is shown."
                                                                },
                                                                "is_partial": {
                                                                    "type": [
                                                                        "boolean",
                                                                        "null"
                                                                    ],
                                                                    "description": "True for somebody who exists only through a relationship and has no record of their own."
                                                                },
                                                                "role": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The role this person holds, which is the type's role_a."
                                                                }
                                                            }
                                                        },
                                                        "contact_b": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The person holding role_b.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the contact."
                                                                },
                                                                "slug": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The readable name of the contact, which addresses it as well as its id."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The name of the contact, as it is shown."
                                                                },
                                                                "is_partial": {
                                                                    "type": [
                                                                        "boolean",
                                                                        "null"
                                                                    ],
                                                                    "description": "True for somebody who exists only through a relationship and has no record of their own."
                                                                },
                                                                "role": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The role this person holds, which is the type's role_b."
                                                                }
                                                            }
                                                        },
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "current or ended."
                                                        },
                                                        "started_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "When it started, written as a year, a month and a day, or null."
                                                        },
                                                        "ended_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "When it ended, or null. Always null while the relationship is current."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the relationship was recorded, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "relationship",
                                        "id": "7c1e9a42-5b3d-4f60-a8e2-0d94b6c3f185",
                                        "attributes": {
                                            "relationship_type": {
                                                "id": "b52f0d7e-1c84-4a39-9e6b-3f7a20c5d816",
                                                "name": "Partner",
                                                "is_symmetric": true
                                            },
                                            "contact_a": {
                                                "id": "2d6b8f13-9a07-4c5e-b1f4-6e3a90d2c748",
                                                "slug": "jim-halpert",
                                                "name": "Jim Halpert",
                                                "is_partial": false,
                                                "role": "partner"
                                            },
                                            "contact_b": {
                                                "id": "e8a41c06-7f25-4b93-8d0e-52c9b7f1a364",
                                                "slug": "pam-beesly",
                                                "name": "Pam Beesly",
                                                "is_partial": false,
                                                "role": "partner"
                                            },
                                            "status": "current",
                                            "started_on": "2007-05-10",
                                            "ended_on": null,
                                            "created_at": 1790380800,
                                            "updated_at": 1790380800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/jim-halpert/relationships/7c1e9a42-5b3d-4f60-a8e2-0d94b6c3f185"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "relationships-show-query",
                "tags": [
                    "Relationships"
                ],
                "summary": "Get a relationship",
                "description": "Retrieve one relationship through either of its two people.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault both people live in, named either by the readable name it reports as slug or by its id.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "contact",
                        "in": "path",
                        "required": true,
                        "description": "One of the two people, named either by their slug or by their id. A contact addressed through the wrong vault answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "relationship",
                        "in": "path",
                        "required": true,
                        "description": "The id of the relationship. It is reached through either of its two people, and through anybody else answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A relationship object.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The relationship.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always relationship. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "relationship_type": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "What the link is.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the relationship type."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The name of the relationship type."
                                                                },
                                                                "is_symmetric": {
                                                                    "type": [
                                                                        "boolean",
                                                                        "null"
                                                                    ],
                                                                    "description": "True when both people hold the same role, as partners do."
                                                                }
                                                            }
                                                        },
                                                        "contact_a": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The person holding role_a.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the contact."
                                                                },
                                                                "slug": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The readable name of the contact, which addresses it as well as its id."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The name of the contact, as it is shown."
                                                                },
                                                                "is_partial": {
                                                                    "type": [
                                                                        "boolean",
                                                                        "null"
                                                                    ],
                                                                    "description": "True for somebody who exists only through a relationship and has no record of their own."
                                                                },
                                                                "role": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The role this person holds, which is the type's role_a."
                                                                }
                                                            }
                                                        },
                                                        "contact_b": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The person holding role_b.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the contact."
                                                                },
                                                                "slug": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The readable name of the contact, which addresses it as well as its id."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The name of the contact, as it is shown."
                                                                },
                                                                "is_partial": {
                                                                    "type": [
                                                                        "boolean",
                                                                        "null"
                                                                    ],
                                                                    "description": "True for somebody who exists only through a relationship and has no record of their own."
                                                                },
                                                                "role": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The role this person holds, which is the type's role_b."
                                                                }
                                                            }
                                                        },
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "current or ended."
                                                        },
                                                        "started_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "When it started, written as a year, a month and a day, or null."
                                                        },
                                                        "ended_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "When it ended, or null. Always null while the relationship is current."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the relationship was recorded, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "relationship",
                                        "id": "7c1e9a42-5b3d-4f60-a8e2-0d94b6c3f185",
                                        "attributes": {
                                            "relationship_type": {
                                                "id": "b52f0d7e-1c84-4a39-9e6b-3f7a20c5d816",
                                                "name": "Partner",
                                                "is_symmetric": true
                                            },
                                            "contact_a": {
                                                "id": "2d6b8f13-9a07-4c5e-b1f4-6e3a90d2c748",
                                                "slug": "jim-halpert",
                                                "name": "Jim Halpert",
                                                "is_partial": false,
                                                "role": "partner"
                                            },
                                            "contact_b": {
                                                "id": "e8a41c06-7f25-4b93-8d0e-52c9b7f1a364",
                                                "slug": "pam-beesly",
                                                "name": "Pam Beesly",
                                                "is_partial": false,
                                                "role": "partner"
                                            },
                                            "status": "current",
                                            "started_on": "2007-05-10",
                                            "ended_on": null,
                                            "created_at": 1790380800,
                                            "updated_at": 1790380800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/jim-halpert/relationships/7c1e9a42-5b3d-4f60-a8e2-0d94b6c3f185"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "put": {
                "operationId": "relationships-update",
                "tags": [
                    "Relationships"
                ],
                "summary": "Change a relationship",
                "description": "Change the type of a relationship, whether it ended, its dates or which side holds which role.\n\nEvery field is optional. A field you leave out keeps its value, and a date sent as null is cleared. Setting status back to current clears the end date.\n\nAn end date before the start date answers 422 on ended_on. first_name, last_name and creates_record only apply to somebody without a record of their own, and answer 422 for anybody else, who is renamed on their own record.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault both people live in, named either by the readable name it reports as slug or by its id.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "contact",
                        "in": "path",
                        "required": true,
                        "description": "One of the two people, named either by their slug or by their id. A contact addressed through the wrong vault answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "relationship",
                        "in": "path",
                        "required": true,
                        "description": "The id of the relationship. It is reached through either of its two people, and through anybody else answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "relationship_type": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "The id of a relationship type of your account. A type that is switched off answers 422."
                                    },
                                    "status": {
                                        "type": "string",
                                        "description": "current or ended."
                                    },
                                    "started_on": {
                                        "type": "string",
                                        "description": "When it started, written as a year, a month and a day."
                                    },
                                    "ended_on": {
                                        "type": "string",
                                        "description": "When it ended, for an ended relationship."
                                    },
                                    "holds_role_a": {
                                        "type": "boolean",
                                        "description": "Whether the contact in the address holds role_a and the other person role_b. For a parent and child type, true says the contact is the parent. Ignored for a symmetric type. The current way round when left out."
                                    },
                                    "first_name": {
                                        "type": "string",
                                        "description": "The first name of somebody who has no record of their own. Up to 255 characters."
                                    },
                                    "last_name": {
                                        "type": "string",
                                        "description": "Their last name. Needs first_name."
                                    },
                                    "creates_record": {
                                        "type": "boolean",
                                        "description": "True to give that person a full record of their own in the vault."
                                    }
                                }
                            },
                            "example": {
                                "relationship_type": "b52f0d7e-1c84-4a39-9e6b-3f7a20c5d816",
                                "status": "ended",
                                "started_on": "2007-05-10",
                                "ended_on": "2008-01-15",
                                "holds_role_a": true,
                                "first_name": "Cece",
                                "last_name": "Halpert",
                                "creates_record": false
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The relationship object as it stands now.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The relationship.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always relationship. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "relationship_type": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "What the link is.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the relationship type."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The name of the relationship type."
                                                                },
                                                                "is_symmetric": {
                                                                    "type": [
                                                                        "boolean",
                                                                        "null"
                                                                    ],
                                                                    "description": "True when both people hold the same role, as partners do."
                                                                }
                                                            }
                                                        },
                                                        "contact_a": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The person holding role_a.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the contact."
                                                                },
                                                                "slug": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The readable name of the contact, which addresses it as well as its id."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The name of the contact, as it is shown."
                                                                },
                                                                "is_partial": {
                                                                    "type": [
                                                                        "boolean",
                                                                        "null"
                                                                    ],
                                                                    "description": "True for somebody who exists only through a relationship and has no record of their own."
                                                                },
                                                                "role": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The role this person holds, which is the type's role_a."
                                                                }
                                                            }
                                                        },
                                                        "contact_b": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The person holding role_b.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the contact."
                                                                },
                                                                "slug": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The readable name of the contact, which addresses it as well as its id."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The name of the contact, as it is shown."
                                                                },
                                                                "is_partial": {
                                                                    "type": [
                                                                        "boolean",
                                                                        "null"
                                                                    ],
                                                                    "description": "True for somebody who exists only through a relationship and has no record of their own."
                                                                },
                                                                "role": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The role this person holds, which is the type's role_b."
                                                                }
                                                            }
                                                        },
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "current or ended."
                                                        },
                                                        "started_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "When it started, written as a year, a month and a day, or null."
                                                        },
                                                        "ended_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "When it ended, or null. Always null while the relationship is current."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the relationship was recorded, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it first changes."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "relationship",
                                        "id": "7c1e9a42-5b3d-4f60-a8e2-0d94b6c3f185",
                                        "attributes": {
                                            "relationship_type": {
                                                "id": "b52f0d7e-1c84-4a39-9e6b-3f7a20c5d816",
                                                "name": "Partner",
                                                "is_symmetric": true
                                            },
                                            "contact_a": {
                                                "id": "2d6b8f13-9a07-4c5e-b1f4-6e3a90d2c748",
                                                "slug": "jim-halpert",
                                                "name": "Jim Halpert",
                                                "is_partial": false,
                                                "role": "partner"
                                            },
                                            "contact_b": {
                                                "id": "e8a41c06-7f25-4b93-8d0e-52c9b7f1a364",
                                                "slug": "pam-beesly",
                                                "name": "Pam Beesly",
                                                "is_partial": false,
                                                "role": "partner"
                                            },
                                            "status": "current",
                                            "started_on": "2007-05-10",
                                            "ended_on": null,
                                            "created_at": 1790380800,
                                            "updated_at": 1790380800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/jim-halpert/relationships/7c1e9a42-5b3d-4f60-a8e2-0d94b6c3f185"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "delete": {
                "operationId": "relationships-destroy",
                "tags": [
                    "Relationships"
                ],
                "summary": "Delete a relationship",
                "description": "Delete a relationship. It leaves both people at once.\n\nNeither person is deleted, including somebody who existed only through this relationship.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault both people live in, named either by the readable name it reports as slug or by its id.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "contact",
                        "in": "path",
                        "required": true,
                        "description": "One of the two people, named either by their slug or by their id. A contact addressed through the wrong vault answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "relationship",
                        "in": "path",
                        "required": true,
                        "description": "The id of the relationship. It is reached through either of its two people, and through anybody else answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Nothing at all."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/mcp-calls": {
            "get": {
                "operationId": "mcp-calls-index",
                "tags": [
                    "MCP history"
                ],
                "summary": "List MCP calls",
                "description": "List the calls assistants made to your account through MCP, newest first.\n\nThe account log records what changed. This records what was asked: every tool call, whether it read, changed, was refused, was given wrong parameters or failed. A call made with no valid key is never attributed to an account, so it never appears here.\n\nCalls are kept for 90 days by default, a period the instance sets, and then removed. Nothing here can be written, changed or removed through the API.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "period",
                        "in": "query",
                        "required": false,
                        "description": "How far back to look: day for the last 24 hours, week for the last 7 days, month for the last 30 days, or all for everything still kept. Any other value answers 422.",
                        "schema": {
                            "type": "string",
                            "default": "all"
                        }
                    },
                    {
                        "name": "connection",
                        "in": "query",
                        "required": false,
                        "description": "Only the calls of one connection, written as its type and its id joined by a colon, such as api_key:14 or oauth_client:9a1f4c2e-7b3d-4f8a-a6e1-3c5d9b2e7f14.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "result",
                        "in": "query",
                        "required": false,
                        "description": "Only the calls with one result: succeeded, refused, invalid_parameters, error or interrupted. Any other value answers 422.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "tool",
                        "in": "query",
                        "required": false,
                        "description": "Only the calls to one tool, by its name, such as get-contact.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to answer with.",
                        "schema": {
                            "type": "integer",
                            "default": 1
                        }
                    },
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "How many calls one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused.",
                        "schema": {
                            "type": "integer",
                            "default": 25
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of calls, and how many there are in all.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The calls on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One call.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always mcp_call. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "started_at_in_milliseconds": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the call started, as a count of milliseconds since 1970. Milliseconds rather than seconds, because an assistant often makes several calls within the same second."
                                                            },
                                                            "duration_in_milliseconds": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How long the tool took, or null while the call is interrupted."
                                                            },
                                                            "connection": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "What the assistant connected with.",
                                                                "properties": {
                                                                    "type": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "api_key for an API key, oauth_client for an assistant connected through OAuth."
                                                                    },
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The id of the key or of the OAuth client. It stays after the key is revoked or the assistant disconnected."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name the connection had when the call was made. It is the name you or the assistant chose, not a verified identity of whoever made the assistant."
                                                                    }
                                                                }
                                                            },
                                                            "tool": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The name of the tool, as the assistant sent it, such as get-contact."
                                                            },
                                                            "operation": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "read, create, update or delete, taken from the API endpoint the tool mirrors. Null for a tool that does not exist."
                                                            },
                                                            "vault": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The vault the call reached, or null when it named none inside your account.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the vault, or null once the vault is deleted."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name the vault had when the call was made."
                                                                    }
                                                                }
                                                            },
                                                            "subject": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The record the call reached, or null when it reached none inside your account.",
                                                                "properties": {
                                                                    "type": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What kind of record it is, such as contact or life_event."
                                                                    },
                                                                    "label": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name the record had when the call was made."
                                                                    }
                                                                }
                                                            },
                                                            "result": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "succeeded, refused, invalid_parameters, error or interrupted. It is read from what the tool answered, never from the HTTP status, which is 200 for a failed tool call too. A call that started and never finished stays interrupted."
                                                            },
                                                            "error": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "Why the call did not succeed, or null when it did.",
                                                                "properties": {
                                                                    "code": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "The JSON-RPC code: -32602 when the parameters or the record were refused, -32603 for anything else."
                                                                    },
                                                                    "message": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The reason sent to the assistant, word for word."
                                                                    }
                                                                }
                                                            },
                                                            "json_rpc_id": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The id the assistant gave the request, as a string."
                                                            },
                                                            "ip_address": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The address the request came from, up to 45 characters."
                                                            },
                                                            "parameters": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The parameters the assistant sent, as JSON, with secrets and the values of sensitive fields masked before they were stored."
                                                            },
                                                            "parameters_truncated": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the parameters were longer than 16 384 bytes and only their beginning was kept, in which case parameters is not valid JSON."
                                                            },
                                                            "response": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The response the assistant received, as JSON, masked the same way, or null when the call ended in a JSON-RPC error."
                                                            },
                                                            "response_truncated": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the response was cut the same way."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "mcp_call",
                                            "id": "5b1f0e9c-2d4a-4c7e-8b36-1a9e7d2c4f03",
                                            "attributes": {
                                                "started_at_in_milliseconds": 1792765991204,
                                                "duration_in_milliseconds": 21,
                                                "connection": {
                                                    "type": "oauth_client",
                                                    "id": "9a1f4c2e-7b3d-4f8a-a6e1-3c5d9b2e7f14",
                                                    "name": "Claude"
                                                },
                                                "tool": "update-life-event",
                                                "operation": "update",
                                                "vault": {
                                                    "id": "0f7e2c1a-6b3d-4e59-8a21-5c9d3b7e1f60",
                                                    "name": "Dunder Mifflin"
                                                },
                                                "subject": {
                                                    "type": "life_event",
                                                    "label": "Dundies"
                                                },
                                                "result": "invalid_parameters",
                                                "error": {
                                                    "code": -32602,
                                                    "message": "The happened on field must match the format Y-m-d."
                                                },
                                                "json_rpc_id": "8",
                                                "ip_address": "192.168.1.24",
                                                "parameters": "{\"vault\":\"dunder-mifflin\",\"life_event\":\"7c2e9a14-3b5d-4f61-8e27-9d1a4c6b2f85\",\"happened_on\":\"31/02/1978\"}",
                                                "parameters_truncated": false,
                                                "response": "{\"content\":[{\"type\":\"text\",\"text\":\"The happened on field must match the format Y-m-d.\"}],\"isError\":true}",
                                                "response_truncated": false
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/mcp-calls/5b1f0e9c-2d4a-4c7e-8b36-1a9e7d2c4f03"
                                            }
                                        },
                                        {
                                            "type": "mcp_call",
                                            "id": "9d3c6a52-4a8e-4f6b-9f1e-2b7c1d0e5a41",
                                            "attributes": {
                                                "started_at_in_milliseconds": 1792765927412,
                                                "duration_in_milliseconds": 58,
                                                "connection": {
                                                    "type": "api_key",
                                                    "id": "14",
                                                    "name": "Dundie awards bot"
                                                },
                                                "tool": "get-contact",
                                                "operation": "read",
                                                "vault": {
                                                    "id": "0f7e2c1a-6b3d-4e59-8a21-5c9d3b7e1f60",
                                                    "name": "Dunder Mifflin"
                                                },
                                                "subject": {
                                                    "type": "contact",
                                                    "label": "Dwight Schrute"
                                                },
                                                "result": "succeeded",
                                                "error": null,
                                                "json_rpc_id": "7",
                                                "ip_address": "192.168.1.24",
                                                "parameters": "{\"vault\":\"dunder-mifflin\",\"contact\":\"dwight-schrute\"}",
                                                "parameters_truncated": false,
                                                "response": "{\"content\":[{\"type\":\"text\",\"text\":\"{\\\"name\\\":\\\"Dwight Schrute\\\"}\"}],\"isError\":false}",
                                                "response_truncated": false
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/mcp-calls/9d3c6a52-4a8e-4f6b-9f1e-2b7c1d0e5a41"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 2
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "mcp-calls-index-query",
                "tags": [
                    "MCP history"
                ],
                "summary": "List MCP calls",
                "description": "List the calls assistants made to your account through MCP, newest first.\n\nThe account log records what changed. This records what was asked: every tool call, whether it read, changed, was refused, was given wrong parameters or failed. A call made with no valid key is never attributed to an account, so it never appears here.\n\nCalls are kept for 90 days by default, a period the instance sets, and then removed. Nothing here can be written, changed or removed through the API.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "period": {
                                        "type": "string",
                                        "default": "all",
                                        "description": "How far back to look: day for the last 24 hours, week for the last 7 days, month for the last 30 days, or all for everything still kept. Any other value answers 422."
                                    },
                                    "connection": {
                                        "type": "string",
                                        "description": "Only the calls of one connection, written as its type and its id joined by a colon, such as api_key:14 or oauth_client:9a1f4c2e-7b3d-4f8a-a6e1-3c5d9b2e7f14."
                                    },
                                    "result": {
                                        "type": "string",
                                        "description": "Only the calls with one result: succeeded, refused, invalid_parameters, error or interrupted. Any other value answers 422."
                                    },
                                    "tool": {
                                        "type": "string",
                                        "description": "Only the calls to one tool, by its name, such as get-contact."
                                    },
                                    "page": {
                                        "type": "integer",
                                        "default": 1,
                                        "description": "Which page to answer with."
                                    },
                                    "per_page": {
                                        "type": "integer",
                                        "default": 25,
                                        "description": "How many calls one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "A page of calls, and how many there are in all.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The calls on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One call.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always mcp_call. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "started_at_in_milliseconds": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the call started, as a count of milliseconds since 1970. Milliseconds rather than seconds, because an assistant often makes several calls within the same second."
                                                            },
                                                            "duration_in_milliseconds": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How long the tool took, or null while the call is interrupted."
                                                            },
                                                            "connection": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "What the assistant connected with.",
                                                                "properties": {
                                                                    "type": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "api_key for an API key, oauth_client for an assistant connected through OAuth."
                                                                    },
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The id of the key or of the OAuth client. It stays after the key is revoked or the assistant disconnected."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name the connection had when the call was made. It is the name you or the assistant chose, not a verified identity of whoever made the assistant."
                                                                    }
                                                                }
                                                            },
                                                            "tool": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The name of the tool, as the assistant sent it, such as get-contact."
                                                            },
                                                            "operation": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "read, create, update or delete, taken from the API endpoint the tool mirrors. Null for a tool that does not exist."
                                                            },
                                                            "vault": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The vault the call reached, or null when it named none inside your account.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the vault, or null once the vault is deleted."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name the vault had when the call was made."
                                                                    }
                                                                }
                                                            },
                                                            "subject": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The record the call reached, or null when it reached none inside your account.",
                                                                "properties": {
                                                                    "type": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What kind of record it is, such as contact or life_event."
                                                                    },
                                                                    "label": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name the record had when the call was made."
                                                                    }
                                                                }
                                                            },
                                                            "result": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "succeeded, refused, invalid_parameters, error or interrupted. It is read from what the tool answered, never from the HTTP status, which is 200 for a failed tool call too. A call that started and never finished stays interrupted."
                                                            },
                                                            "error": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "Why the call did not succeed, or null when it did.",
                                                                "properties": {
                                                                    "code": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "The JSON-RPC code: -32602 when the parameters or the record were refused, -32603 for anything else."
                                                                    },
                                                                    "message": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The reason sent to the assistant, word for word."
                                                                    }
                                                                }
                                                            },
                                                            "json_rpc_id": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The id the assistant gave the request, as a string."
                                                            },
                                                            "ip_address": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The address the request came from, up to 45 characters."
                                                            },
                                                            "parameters": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The parameters the assistant sent, as JSON, with secrets and the values of sensitive fields masked before they were stored."
                                                            },
                                                            "parameters_truncated": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the parameters were longer than 16 384 bytes and only their beginning was kept, in which case parameters is not valid JSON."
                                                            },
                                                            "response": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The response the assistant received, as JSON, masked the same way, or null when the call ended in a JSON-RPC error."
                                                            },
                                                            "response_truncated": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the response was cut the same way."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "mcp_call",
                                            "id": "5b1f0e9c-2d4a-4c7e-8b36-1a9e7d2c4f03",
                                            "attributes": {
                                                "started_at_in_milliseconds": 1792765991204,
                                                "duration_in_milliseconds": 21,
                                                "connection": {
                                                    "type": "oauth_client",
                                                    "id": "9a1f4c2e-7b3d-4f8a-a6e1-3c5d9b2e7f14",
                                                    "name": "Claude"
                                                },
                                                "tool": "update-life-event",
                                                "operation": "update",
                                                "vault": {
                                                    "id": "0f7e2c1a-6b3d-4e59-8a21-5c9d3b7e1f60",
                                                    "name": "Dunder Mifflin"
                                                },
                                                "subject": {
                                                    "type": "life_event",
                                                    "label": "Dundies"
                                                },
                                                "result": "invalid_parameters",
                                                "error": {
                                                    "code": -32602,
                                                    "message": "The happened on field must match the format Y-m-d."
                                                },
                                                "json_rpc_id": "8",
                                                "ip_address": "192.168.1.24",
                                                "parameters": "{\"vault\":\"dunder-mifflin\",\"life_event\":\"7c2e9a14-3b5d-4f61-8e27-9d1a4c6b2f85\",\"happened_on\":\"31/02/1978\"}",
                                                "parameters_truncated": false,
                                                "response": "{\"content\":[{\"type\":\"text\",\"text\":\"The happened on field must match the format Y-m-d.\"}],\"isError\":true}",
                                                "response_truncated": false
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/mcp-calls/5b1f0e9c-2d4a-4c7e-8b36-1a9e7d2c4f03"
                                            }
                                        },
                                        {
                                            "type": "mcp_call",
                                            "id": "9d3c6a52-4a8e-4f6b-9f1e-2b7c1d0e5a41",
                                            "attributes": {
                                                "started_at_in_milliseconds": 1792765927412,
                                                "duration_in_milliseconds": 58,
                                                "connection": {
                                                    "type": "api_key",
                                                    "id": "14",
                                                    "name": "Dundie awards bot"
                                                },
                                                "tool": "get-contact",
                                                "operation": "read",
                                                "vault": {
                                                    "id": "0f7e2c1a-6b3d-4e59-8a21-5c9d3b7e1f60",
                                                    "name": "Dunder Mifflin"
                                                },
                                                "subject": {
                                                    "type": "contact",
                                                    "label": "Dwight Schrute"
                                                },
                                                "result": "succeeded",
                                                "error": null,
                                                "json_rpc_id": "7",
                                                "ip_address": "192.168.1.24",
                                                "parameters": "{\"vault\":\"dunder-mifflin\",\"contact\":\"dwight-schrute\"}",
                                                "parameters_truncated": false,
                                                "response": "{\"content\":[{\"type\":\"text\",\"text\":\"{\\\"name\\\":\\\"Dwight Schrute\\\"}\"}],\"isError\":false}",
                                                "response_truncated": false
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/mcp-calls/9d3c6a52-4a8e-4f6b-9f1e-2b7c1d0e5a41"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 2
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/mcp-calls/{mcpCall}": {
            "get": {
                "operationId": "mcp-calls-show",
                "tags": [
                    "MCP history"
                ],
                "summary": "Get an MCP call",
                "description": "Retrieve one call an assistant made to your account through MCP.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "mcpCall",
                        "in": "path",
                        "required": true,
                        "description": "The id of the call.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A call. A call from another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The call.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always mcp_call. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "started_at_in_milliseconds": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the call started, as a count of milliseconds since 1970. Milliseconds rather than seconds, because an assistant often makes several calls within the same second."
                                                        },
                                                        "duration_in_milliseconds": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How long the tool took, or null while the call is interrupted."
                                                        },
                                                        "connection": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "What the assistant connected with.",
                                                            "properties": {
                                                                "type": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "api_key for an API key, oauth_client for an assistant connected through OAuth."
                                                                },
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The id of the key or of the OAuth client. It stays after the key is revoked or the assistant disconnected."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The name the connection had when the call was made. It is the name you or the assistant chose, not a verified identity of whoever made the assistant."
                                                                }
                                                            }
                                                        },
                                                        "tool": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The name of the tool, as the assistant sent it, such as get-contact."
                                                        },
                                                        "operation": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "read, create, update or delete, taken from the API endpoint the tool mirrors. Null for a tool that does not exist."
                                                        },
                                                        "vault": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The vault the call reached, or null when it named none inside your account.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the vault, or null once the vault is deleted."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The name the vault had when the call was made."
                                                                }
                                                            }
                                                        },
                                                        "subject": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The record the call reached, or null when it reached none inside your account.",
                                                            "properties": {
                                                                "type": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What kind of record it is, such as contact or life_event."
                                                                },
                                                                "label": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The name the record had when the call was made."
                                                                }
                                                            }
                                                        },
                                                        "result": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "succeeded, refused, invalid_parameters, error or interrupted. It is read from what the tool answered, never from the HTTP status, which is 200 for a failed tool call too. A call that started and never finished stays interrupted."
                                                        },
                                                        "error": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "Why the call did not succeed, or null when it did.",
                                                            "properties": {
                                                                "code": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "The JSON-RPC code: -32602 when the parameters or the record were refused, -32603 for anything else."
                                                                },
                                                                "message": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The reason sent to the assistant, word for word."
                                                                }
                                                            }
                                                        },
                                                        "json_rpc_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The id the assistant gave the request, as a string."
                                                        },
                                                        "ip_address": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The address the request came from, up to 45 characters."
                                                        },
                                                        "parameters": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The parameters the assistant sent, as JSON, with secrets and the values of sensitive fields masked before they were stored."
                                                        },
                                                        "parameters_truncated": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the parameters were longer than 16 384 bytes and only their beginning was kept, in which case parameters is not valid JSON."
                                                        },
                                                        "response": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The response the assistant received, as JSON, masked the same way, or null when the call ended in a JSON-RPC error."
                                                        },
                                                        "response_truncated": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the response was cut the same way."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "mcp_call",
                                        "id": "5b1f0e9c-2d4a-4c7e-8b36-1a9e7d2c4f03",
                                        "attributes": {
                                            "started_at_in_milliseconds": 1792765991204,
                                            "duration_in_milliseconds": 21,
                                            "connection": {
                                                "type": "oauth_client",
                                                "id": "9a1f4c2e-7b3d-4f8a-a6e1-3c5d9b2e7f14",
                                                "name": "Claude"
                                            },
                                            "tool": "update-life-event",
                                            "operation": "update",
                                            "vault": {
                                                "id": "0f7e2c1a-6b3d-4e59-8a21-5c9d3b7e1f60",
                                                "name": "Dunder Mifflin"
                                            },
                                            "subject": {
                                                "type": "life_event",
                                                "label": "Dundies"
                                            },
                                            "result": "invalid_parameters",
                                            "error": {
                                                "code": -32602,
                                                "message": "The happened on field must match the format Y-m-d."
                                            },
                                            "json_rpc_id": "8",
                                            "ip_address": "192.168.1.24",
                                            "parameters": "{\"vault\":\"dunder-mifflin\",\"life_event\":\"7c2e9a14-3b5d-4f61-8e27-9d1a4c6b2f85\",\"happened_on\":\"31/02/1978\"}",
                                            "parameters_truncated": false,
                                            "response": "{\"content\":[{\"type\":\"text\",\"text\":\"The happened on field must match the format Y-m-d.\"}],\"isError\":true}",
                                            "response_truncated": false
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/mcp-calls/5b1f0e9c-2d4a-4c7e-8b36-1a9e7d2c4f03"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "mcp-calls-show-query",
                "tags": [
                    "MCP history"
                ],
                "summary": "Get an MCP call",
                "description": "Retrieve one call an assistant made to your account through MCP.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "mcpCall",
                        "in": "path",
                        "required": true,
                        "description": "The id of the call.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A call. A call from another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The call.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always mcp_call. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "started_at_in_milliseconds": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the call started, as a count of milliseconds since 1970. Milliseconds rather than seconds, because an assistant often makes several calls within the same second."
                                                        },
                                                        "duration_in_milliseconds": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How long the tool took, or null while the call is interrupted."
                                                        },
                                                        "connection": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "What the assistant connected with.",
                                                            "properties": {
                                                                "type": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "api_key for an API key, oauth_client for an assistant connected through OAuth."
                                                                },
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The id of the key or of the OAuth client. It stays after the key is revoked or the assistant disconnected."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The name the connection had when the call was made. It is the name you or the assistant chose, not a verified identity of whoever made the assistant."
                                                                }
                                                            }
                                                        },
                                                        "tool": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The name of the tool, as the assistant sent it, such as get-contact."
                                                        },
                                                        "operation": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "read, create, update or delete, taken from the API endpoint the tool mirrors. Null for a tool that does not exist."
                                                        },
                                                        "vault": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The vault the call reached, or null when it named none inside your account.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the vault, or null once the vault is deleted."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The name the vault had when the call was made."
                                                                }
                                                            }
                                                        },
                                                        "subject": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The record the call reached, or null when it reached none inside your account.",
                                                            "properties": {
                                                                "type": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What kind of record it is, such as contact or life_event."
                                                                },
                                                                "label": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The name the record had when the call was made."
                                                                }
                                                            }
                                                        },
                                                        "result": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "succeeded, refused, invalid_parameters, error or interrupted. It is read from what the tool answered, never from the HTTP status, which is 200 for a failed tool call too. A call that started and never finished stays interrupted."
                                                        },
                                                        "error": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "Why the call did not succeed, or null when it did.",
                                                            "properties": {
                                                                "code": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "The JSON-RPC code: -32602 when the parameters or the record were refused, -32603 for anything else."
                                                                },
                                                                "message": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The reason sent to the assistant, word for word."
                                                                }
                                                            }
                                                        },
                                                        "json_rpc_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The id the assistant gave the request, as a string."
                                                        },
                                                        "ip_address": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The address the request came from, up to 45 characters."
                                                        },
                                                        "parameters": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The parameters the assistant sent, as JSON, with secrets and the values of sensitive fields masked before they were stored."
                                                        },
                                                        "parameters_truncated": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the parameters were longer than 16 384 bytes and only their beginning was kept, in which case parameters is not valid JSON."
                                                        },
                                                        "response": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The response the assistant received, as JSON, masked the same way, or null when the call ended in a JSON-RPC error."
                                                        },
                                                        "response_truncated": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the response was cut the same way."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "mcp_call",
                                        "id": "5b1f0e9c-2d4a-4c7e-8b36-1a9e7d2c4f03",
                                        "attributes": {
                                            "started_at_in_milliseconds": 1792765991204,
                                            "duration_in_milliseconds": 21,
                                            "connection": {
                                                "type": "oauth_client",
                                                "id": "9a1f4c2e-7b3d-4f8a-a6e1-3c5d9b2e7f14",
                                                "name": "Claude"
                                            },
                                            "tool": "update-life-event",
                                            "operation": "update",
                                            "vault": {
                                                "id": "0f7e2c1a-6b3d-4e59-8a21-5c9d3b7e1f60",
                                                "name": "Dunder Mifflin"
                                            },
                                            "subject": {
                                                "type": "life_event",
                                                "label": "Dundies"
                                            },
                                            "result": "invalid_parameters",
                                            "error": {
                                                "code": -32602,
                                                "message": "The happened on field must match the format Y-m-d."
                                            },
                                            "json_rpc_id": "8",
                                            "ip_address": "192.168.1.24",
                                            "parameters": "{\"vault\":\"dunder-mifflin\",\"life_event\":\"7c2e9a14-3b5d-4f61-8e27-9d1a4c6b2f85\",\"happened_on\":\"31/02/1978\"}",
                                            "parameters_truncated": false,
                                            "response": "{\"content\":[{\"type\":\"text\",\"text\":\"The happened on field must match the format Y-m-d.\"}],\"isError\":true}",
                                            "response_truncated": false
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/mcp-calls/5b1f0e9c-2d4a-4c7e-8b36-1a9e7d2c4f03"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/imports/{accountImport}": {
            "get": {
                "operationId": "account-imports-show",
                "tags": [
                    "Imports"
                ],
                "summary": "Get an import",
                "description": "Retrieve one import: where it stands, what the file holds and, once it has completed, what became of it.\n\nAn import moves on its own, in the background, while its status is reading, writing or rolling_back. Ask again to follow it. An email says when it ends.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "accountImport",
                        "in": "path",
                        "required": true,
                        "description": "The id of the import. One belonging to another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "An import object. One of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The import.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always account_import. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the import stands: reading, refused, read, writing, rolling_back, rolled_back, rollback_failed or completed. rollback_failed means an undo kept failing and what the import wrote is still in place. Nothing is written into a vault before the file is read and you have chosen where it goes."
                                                        },
                                                        "source_format": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the file is: monica_4 for an export of Monica 4, monica for an export of this application. Null while the file is read, and when it was refused as neither."
                                                        },
                                                        "refusal": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Why the file cannot be imported, when the status is refused. Null otherwise."
                                                        },
                                                        "already_imported_into": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The vaults this same file was completely imported into before. An import only adds, so importing it again into one of them writes every record a second time.",
                                                            "items": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "format": "uuid",
                                                                "description": "The id of one of those vaults."
                                                            }
                                                        },
                                                        "progress": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "How far the writing has gone.",
                                                            "properties": {
                                                                "done": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "How many records are written."
                                                                },
                                                                "total": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "How many records there are to write, known once the file is read."
                                                                }
                                                            }
                                                        },
                                                        "vault": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The id of the vault the file is written into, or null until one is chosen."
                                                        },
                                                        "me_contact": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The id, in the file, of the contact who is you, or null for none. Until you choose, it is the contact the file names as its owner."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the file was received, as a count of seconds since 1970."
                                                        },
                                                        "ended_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the import completed or finished being undone, as a count of seconds since 1970, or null."
                                                        },
                                                        "summary": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "What the file holds, one entry per kind of record, once it is read. Null while it is read.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One kind of record in the file.",
                                                                "properties": {
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The kind of record, as the file names it: contacts, notes, relationships, audit_logs and so on."
                                                                    },
                                                                    "found": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "How many the file holds."
                                                                    },
                                                                    "left_out": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "How many will not come over, because this product keeps nothing of that kind."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "report": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "What became of the records of the file, one entry per kind, once the import has completed. Null before that, and for an import that was undone, since nothing of it stayed.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One kind of record.",
                                                                "properties": {
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The kind of record: contact, file, reminder, life_event, relationship, journal_entry and so on. A kind that is only counted while the file is read, such as notes or audit_logs, keeps the name it has in the summary."
                                                                    },
                                                                    "imported": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "How many came over."
                                                                    },
                                                                    "left_out": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "How many did not. GET /imports/{accountImport}/report lists them with the reason."
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "account_import",
                                        "id": "3f8a1c52-7d4e-4b19-9a06-c2e5b8d71f40",
                                        "attributes": {
                                            "status": "completed",
                                            "source_format": "monica_4",
                                            "refusal": null,
                                            "summary": [
                                                {
                                                    "kind": "contacts",
                                                    "found": 1767,
                                                    "left_out": 0
                                                },
                                                {
                                                    "kind": "relationships",
                                                    "found": 94,
                                                    "left_out": 0
                                                },
                                                {
                                                    "kind": "audit_logs",
                                                    "found": 3327,
                                                    "left_out": 3327
                                                }
                                            ],
                                            "already_imported_into": [
                                                "9b2d4f6a-1e3c-4a5b-8c7d-0f1e2d3c4b5a"
                                            ],
                                            "progress": {
                                                "done": 4512,
                                                "total": 4512
                                            },
                                            "vault": "c4e6a8b0-2d4f-4a6b-9c8d-1e3f5a7b9c0d",
                                            "me_contact": "10000000-0000-4000-8000-000000000001",
                                            "report": [
                                                {
                                                    "kind": "contact",
                                                    "imported": 1767,
                                                    "left_out": 0
                                                },
                                                {
                                                    "kind": "reminder",
                                                    "imported": 112,
                                                    "left_out": 6
                                                },
                                                {
                                                    "kind": "relationship",
                                                    "imported": 47,
                                                    "left_out": 47
                                                },
                                                {
                                                    "kind": "audit_logs",
                                                    "imported": 0,
                                                    "left_out": 3327
                                                }
                                            ],
                                            "created_at": 1792310400,
                                            "ended_at": 1792310940
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/imports/3f8a1c52-7d4e-4b19-9a06-c2e5b8d71f40"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "account-imports-show-query",
                "tags": [
                    "Imports"
                ],
                "summary": "Get an import",
                "description": "Retrieve one import: where it stands, what the file holds and, once it has completed, what became of it.\n\nAn import moves on its own, in the background, while its status is reading, writing or rolling_back. Ask again to follow it. An email says when it ends.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "accountImport",
                        "in": "path",
                        "required": true,
                        "description": "The id of the import. One belonging to another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "An import object. One of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The import.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always account_import. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the import stands: reading, refused, read, writing, rolling_back, rolled_back, rollback_failed or completed. rollback_failed means an undo kept failing and what the import wrote is still in place. Nothing is written into a vault before the file is read and you have chosen where it goes."
                                                        },
                                                        "source_format": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the file is: monica_4 for an export of Monica 4, monica for an export of this application. Null while the file is read, and when it was refused as neither."
                                                        },
                                                        "refusal": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Why the file cannot be imported, when the status is refused. Null otherwise."
                                                        },
                                                        "already_imported_into": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The vaults this same file was completely imported into before. An import only adds, so importing it again into one of them writes every record a second time.",
                                                            "items": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "format": "uuid",
                                                                "description": "The id of one of those vaults."
                                                            }
                                                        },
                                                        "progress": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "How far the writing has gone.",
                                                            "properties": {
                                                                "done": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "How many records are written."
                                                                },
                                                                "total": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "How many records there are to write, known once the file is read."
                                                                }
                                                            }
                                                        },
                                                        "vault": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The id of the vault the file is written into, or null until one is chosen."
                                                        },
                                                        "me_contact": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The id, in the file, of the contact who is you, or null for none. Until you choose, it is the contact the file names as its owner."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the file was received, as a count of seconds since 1970."
                                                        },
                                                        "ended_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the import completed or finished being undone, as a count of seconds since 1970, or null."
                                                        },
                                                        "summary": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "What the file holds, one entry per kind of record, once it is read. Null while it is read.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One kind of record in the file.",
                                                                "properties": {
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The kind of record, as the file names it: contacts, notes, relationships, audit_logs and so on."
                                                                    },
                                                                    "found": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "How many the file holds."
                                                                    },
                                                                    "left_out": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "How many will not come over, because this product keeps nothing of that kind."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "report": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "What became of the records of the file, one entry per kind, once the import has completed. Null before that, and for an import that was undone, since nothing of it stayed.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One kind of record.",
                                                                "properties": {
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The kind of record: contact, file, reminder, life_event, relationship, journal_entry and so on. A kind that is only counted while the file is read, such as notes or audit_logs, keeps the name it has in the summary."
                                                                    },
                                                                    "imported": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "How many came over."
                                                                    },
                                                                    "left_out": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "How many did not. GET /imports/{accountImport}/report lists them with the reason."
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "account_import",
                                        "id": "3f8a1c52-7d4e-4b19-9a06-c2e5b8d71f40",
                                        "attributes": {
                                            "status": "completed",
                                            "source_format": "monica_4",
                                            "refusal": null,
                                            "summary": [
                                                {
                                                    "kind": "contacts",
                                                    "found": 1767,
                                                    "left_out": 0
                                                },
                                                {
                                                    "kind": "relationships",
                                                    "found": 94,
                                                    "left_out": 0
                                                },
                                                {
                                                    "kind": "audit_logs",
                                                    "found": 3327,
                                                    "left_out": 3327
                                                }
                                            ],
                                            "already_imported_into": [
                                                "9b2d4f6a-1e3c-4a5b-8c7d-0f1e2d3c4b5a"
                                            ],
                                            "progress": {
                                                "done": 4512,
                                                "total": 4512
                                            },
                                            "vault": "c4e6a8b0-2d4f-4a6b-9c8d-1e3f5a7b9c0d",
                                            "me_contact": "10000000-0000-4000-8000-000000000001",
                                            "report": [
                                                {
                                                    "kind": "contact",
                                                    "imported": 1767,
                                                    "left_out": 0
                                                },
                                                {
                                                    "kind": "reminder",
                                                    "imported": 112,
                                                    "left_out": 6
                                                },
                                                {
                                                    "kind": "relationship",
                                                    "imported": 47,
                                                    "left_out": 47
                                                },
                                                {
                                                    "kind": "audit_logs",
                                                    "imported": 0,
                                                    "left_out": 3327
                                                }
                                            ],
                                            "created_at": 1792310400,
                                            "ended_at": 1792310940
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/imports/3f8a1c52-7d4e-4b19-9a06-c2e5b8d71f40"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "put": {
                "operationId": "account-imports-update",
                "tags": [
                    "Imports"
                ],
                "summary": "Start an import",
                "description": "Choose where a file that has been read goes and which of its contacts is you, then start writing it.\n\nName a vault of the account with vault, or a new vault with vault_name. A file holding several vaults takes neither: each of its vaults arrives as a new vault of its own, and the contact each one marks as you is added to its Me, so me_contact is ignored too.\n\nThe contact named by me_contact is added to the Me contact of the vault: its values fill only what Me leaves empty, and its relationships and life events attach to Me. Send null to import every contact as somebody else. The contacts of the file come from GET /imports/{accountImport}/contacts.\n\nThe limits of the account are compared with the whole file before anything is written. A file that would take the account past its contacts, its vaults or its storage answers 422, saying which limit, and nothing is written. So does an import that is not waiting for a decision.\n\nAn import only adds records. It never changes or removes one the vault already holds. It is written in the background: ask for the import to follow its progress.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "accountImport",
                        "in": "path",
                        "required": true,
                        "description": "The id of the import. One belonging to another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "vault": {
                                        "type": "string",
                                        "description": "A vault of the account to write the file into, named by its slug or its id. A vault of another account answers 404."
                                    },
                                    "vault_name": {
                                        "type": "string",
                                        "description": "The name of a new vault to write the file into, up to 255 characters. Required when vault is left out, unless the file holds several vaults."
                                    },
                                    "me_contact": {
                                        "type": "string",
                                        "description": "The id, in the file, of the contact who is you, or null for none. A contact the file does not hold answers 422."
                                    }
                                }
                            },
                            "example": {
                                "vault_name": "Dunder Mifflin",
                                "me_contact": "10000000-0000-4000-8000-000000000001"
                            }
                        }
                    }
                },
                "responses": {
                    "202": {
                        "description": "The import object, writing.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The import.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always account_import. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the import stands: reading, refused, read, writing, rolling_back, rolled_back, rollback_failed or completed. rollback_failed means an undo kept failing and what the import wrote is still in place. Nothing is written into a vault before the file is read and you have chosen where it goes."
                                                        },
                                                        "source_format": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the file is: monica_4 for an export of Monica 4, monica for an export of this application. Null while the file is read, and when it was refused as neither."
                                                        },
                                                        "refusal": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Why the file cannot be imported, when the status is refused. Null otherwise."
                                                        },
                                                        "already_imported_into": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The vaults this same file was completely imported into before. An import only adds, so importing it again into one of them writes every record a second time.",
                                                            "items": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "format": "uuid",
                                                                "description": "The id of one of those vaults."
                                                            }
                                                        },
                                                        "progress": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "How far the writing has gone.",
                                                            "properties": {
                                                                "done": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "How many records are written."
                                                                },
                                                                "total": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "How many records there are to write, known once the file is read."
                                                                }
                                                            }
                                                        },
                                                        "vault": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The id of the vault the file is written into, or null until one is chosen."
                                                        },
                                                        "me_contact": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The id, in the file, of the contact who is you, or null for none. Until you choose, it is the contact the file names as its owner."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the file was received, as a count of seconds since 1970."
                                                        },
                                                        "ended_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the import completed or finished being undone, as a count of seconds since 1970, or null."
                                                        },
                                                        "summary": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "What the file holds, one entry per kind of record, once it is read. Null while it is read.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One kind of record in the file.",
                                                                "properties": {
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The kind of record, as the file names it: contacts, notes, relationships, audit_logs and so on."
                                                                    },
                                                                    "found": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "How many the file holds."
                                                                    },
                                                                    "left_out": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "How many will not come over, because this product keeps nothing of that kind."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "report": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "What became of the records of the file, one entry per kind, once the import has completed. Null before that, and for an import that was undone, since nothing of it stayed."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "account_import",
                                        "id": "3f8a1c52-7d4e-4b19-9a06-c2e5b8d71f40",
                                        "attributes": {
                                            "status": "writing",
                                            "source_format": "monica_4",
                                            "refusal": null,
                                            "summary": [
                                                {
                                                    "kind": "contacts",
                                                    "found": 1767,
                                                    "left_out": 0
                                                },
                                                {
                                                    "kind": "relationships",
                                                    "found": 94,
                                                    "left_out": 0
                                                },
                                                {
                                                    "kind": "audit_logs",
                                                    "found": 3327,
                                                    "left_out": 3327
                                                }
                                            ],
                                            "already_imported_into": [
                                                "9b2d4f6a-1e3c-4a5b-8c7d-0f1e2d3c4b5a"
                                            ],
                                            "progress": {
                                                "done": 0,
                                                "total": 4512
                                            },
                                            "vault": "c4e6a8b0-2d4f-4a6b-9c8d-1e3f5a7b9c0d",
                                            "me_contact": "10000000-0000-4000-8000-000000000001",
                                            "report": null,
                                            "created_at": 1792310400,
                                            "ended_at": null
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/imports/3f8a1c52-7d4e-4b19-9a06-c2e5b8d71f40"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "delete": {
                "operationId": "account-imports-destroy",
                "tags": [
                    "Imports"
                ],
                "summary": "Cancel an import",
                "description": "Stop an import and leave the account as it was before it started.\n\nAn import that is writing is undone in the background: everything it wrote is removed, a vault it created is deleted, and the answer is the import, being rolled back.\n\nAn import that has not started writing is discarded with its file, and the answer is 204 with no body.\n\nAn import that has ended cannot be cancelled, and answers 422.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "accountImport",
                        "in": "path",
                        "required": true,
                        "description": "The id of the import. One belonging to another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "202": {
                        "description": "The import object, being rolled back.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The import.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always account_import. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the import stands: reading, refused, read, writing, rolling_back, rolled_back, rollback_failed or completed. rollback_failed means an undo kept failing and what the import wrote is still in place. Nothing is written into a vault before the file is read and you have chosen where it goes."
                                                        },
                                                        "source_format": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the file is: monica_4 for an export of Monica 4, monica for an export of this application. Null while the file is read, and when it was refused as neither."
                                                        },
                                                        "refusal": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Why the file cannot be imported, when the status is refused. Null otherwise."
                                                        },
                                                        "already_imported_into": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The vaults this same file was completely imported into before. An import only adds, so importing it again into one of them writes every record a second time.",
                                                            "items": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "format": "uuid",
                                                                "description": "The id of one of those vaults."
                                                            }
                                                        },
                                                        "progress": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "How far the writing has gone.",
                                                            "properties": {
                                                                "done": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "How many records are written."
                                                                },
                                                                "total": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "How many records there are to write, known once the file is read."
                                                                }
                                                            }
                                                        },
                                                        "vault": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The id of the vault the file is written into, or null until one is chosen."
                                                        },
                                                        "me_contact": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The id, in the file, of the contact who is you, or null for none. Until you choose, it is the contact the file names as its owner."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the file was received, as a count of seconds since 1970."
                                                        },
                                                        "ended_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the import completed or finished being undone, as a count of seconds since 1970, or null."
                                                        },
                                                        "summary": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "What the file holds, one entry per kind of record, once it is read. Null while it is read.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One kind of record in the file.",
                                                                "properties": {
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The kind of record, as the file names it: contacts, notes, relationships, audit_logs and so on."
                                                                    },
                                                                    "found": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "How many the file holds."
                                                                    },
                                                                    "left_out": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "How many will not come over, because this product keeps nothing of that kind."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "report": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "What became of the records of the file, one entry per kind, once the import has completed. Null before that, and for an import that was undone, since nothing of it stayed."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "account_import",
                                        "id": "3f8a1c52-7d4e-4b19-9a06-c2e5b8d71f40",
                                        "attributes": {
                                            "status": "rolling_back",
                                            "source_format": "monica_4",
                                            "refusal": null,
                                            "summary": [
                                                {
                                                    "kind": "contacts",
                                                    "found": 1767,
                                                    "left_out": 0
                                                },
                                                {
                                                    "kind": "relationships",
                                                    "found": 94,
                                                    "left_out": 0
                                                },
                                                {
                                                    "kind": "audit_logs",
                                                    "found": 3327,
                                                    "left_out": 3327
                                                }
                                            ],
                                            "already_imported_into": [
                                                "9b2d4f6a-1e3c-4a5b-8c7d-0f1e2d3c4b5a"
                                            ],
                                            "progress": {
                                                "done": 1200,
                                                "total": 4512
                                            },
                                            "vault": "c4e6a8b0-2d4f-4a6b-9c8d-1e3f5a7b9c0d",
                                            "me_contact": "10000000-0000-4000-8000-000000000001",
                                            "report": null,
                                            "created_at": 1792310400,
                                            "ended_at": null
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/imports/3f8a1c52-7d4e-4b19-9a06-c2e5b8d71f40"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/imports": {
            "post": {
                "operationId": "account-imports-create",
                "tags": [
                    "Imports"
                ],
                "summary": "Import a file",
                "description": "Send an export of Monica 4, or an export of this application, to be read. Nothing is written into a vault yet.\n\nSend the file as multipart form data, in a field called file. A file over 512 MB answers 422. The console of the instance imports a larger one with php artisan monica:import-account.\n\nThe file is read in the background. Ask for the import until its status is read, look at what it holds, then choose where it goes with PUT /imports/{accountImport}. A file that cannot be imported ends as refused, with the reason.\n\nAn account runs one import at a time. Sending a file while another import is reading, waiting for a decision, writing or being undone answers 422.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": true,
                    "content": {
                        "multipart/form-data": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "file": {
                                        "type": "string",
                                        "format": "binary",
                                        "description": "The export, as the JSON file Monica 4 or this application wrote it, at most 512 MB."
                                    }
                                },
                                "required": [
                                    "file"
                                ]
                            }
                        }
                    }
                },
                "responses": {
                    "202": {
                        "description": "The import object, reading the file.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The import.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always account_import. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the import stands: reading, refused, read, writing, rolling_back, rolled_back, rollback_failed or completed. rollback_failed means an undo kept failing and what the import wrote is still in place. Nothing is written into a vault before the file is read and you have chosen where it goes."
                                                        },
                                                        "source_format": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the file is: monica_4 for an export of Monica 4, monica for an export of this application. Null while the file is read, and when it was refused as neither."
                                                        },
                                                        "refusal": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Why the file cannot be imported, when the status is refused. Null otherwise."
                                                        },
                                                        "already_imported_into": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The vaults this same file was completely imported into before. An import only adds, so importing it again into one of them writes every record a second time.",
                                                            "items": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "format": "uuid",
                                                                "description": "The id of one of those vaults."
                                                            }
                                                        },
                                                        "progress": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "How far the writing has gone.",
                                                            "properties": {
                                                                "done": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "How many records are written."
                                                                },
                                                                "total": {
                                                                    "type": [
                                                                        "integer",
                                                                        "null"
                                                                    ],
                                                                    "description": "How many records there are to write, known once the file is read."
                                                                }
                                                            }
                                                        },
                                                        "vault": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The id of the vault the file is written into, or null until one is chosen."
                                                        },
                                                        "me_contact": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The id, in the file, of the contact who is you, or null for none. Until you choose, it is the contact the file names as its owner."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the file was received, as a count of seconds since 1970."
                                                        },
                                                        "ended_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the import completed or finished being undone, as a count of seconds since 1970, or null."
                                                        },
                                                        "summary": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "What the file holds, one entry per kind of record, once it is read. Null while it is read."
                                                        },
                                                        "report": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "What became of the records of the file, one entry per kind, once the import has completed. Null before that, and for an import that was undone, since nothing of it stayed."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "account_import",
                                        "id": "3f8a1c52-7d4e-4b19-9a06-c2e5b8d71f40",
                                        "attributes": {
                                            "status": "reading",
                                            "source_format": null,
                                            "refusal": null,
                                            "summary": null,
                                            "already_imported_into": [
                                                "9b2d4f6a-1e3c-4a5b-8c7d-0f1e2d3c4b5a"
                                            ],
                                            "progress": {
                                                "done": 0,
                                                "total": 0
                                            },
                                            "vault": null,
                                            "me_contact": null,
                                            "report": null,
                                            "created_at": 1792310400,
                                            "ended_at": null
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/imports/3f8a1c52-7d4e-4b19-9a06-c2e5b8d71f40"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/imports/{accountImport}/contacts": {
            "get": {
                "operationId": "account-imports-contacts-index",
                "tags": [
                    "Imports"
                ],
                "summary": "List the contacts of a file",
                "description": "List the contacts a file holds, by name, to choose which of them is you.\n\nThe id of each is what me_contact takes when the import is started. The list is empty while the file is read.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "accountImport",
                        "in": "path",
                        "required": true,
                        "description": "The id of the import. One belonging to another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "search",
                        "in": "query",
                        "required": false,
                        "description": "Only the contacts whose name holds these letters, in capitals or not.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to answer with.",
                        "schema": {
                            "type": "integer",
                            "default": 1
                        }
                    },
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "How many records one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused.",
                        "schema": {
                            "type": "integer",
                            "default": 25
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of the contacts of the file, sorted by name. An import of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The contacts of the file on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One contact of the file.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always account_import_contact. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The first and last name the file gives the contact, or null when it gives none."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "account_import_contact",
                                            "id": "10000000-0000-4000-8000-000000000002",
                                            "attributes": {
                                                "name": "Dwight Schrute"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "account-imports-contacts-index-query",
                "tags": [
                    "Imports"
                ],
                "summary": "List the contacts of a file",
                "description": "List the contacts a file holds, by name, to choose which of them is you.\n\nThe id of each is what me_contact takes when the import is started. The list is empty while the file is read.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "accountImport",
                        "in": "path",
                        "required": true,
                        "description": "The id of the import. One belonging to another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "search": {
                                        "type": "string",
                                        "description": "Only the contacts whose name holds these letters, in capitals or not."
                                    },
                                    "page": {
                                        "type": "integer",
                                        "default": 1,
                                        "description": "Which page to answer with."
                                    },
                                    "per_page": {
                                        "type": "integer",
                                        "default": 25,
                                        "description": "How many records one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "A page of the contacts of the file, sorted by name. An import of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The contacts of the file on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One contact of the file.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always account_import_contact. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The first and last name the file gives the contact, or null when it gives none."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "account_import_contact",
                                            "id": "10000000-0000-4000-8000-000000000002",
                                            "attributes": {
                                                "name": "Dwight Schrute"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/imports/{accountImport}/report": {
            "get": {
                "operationId": "account-imports-report-index",
                "tags": [
                    "Imports"
                ],
                "summary": "List what an import left out",
                "description": "List the records of the file that did not come over, and why.\n\nSome are known as soon as the file is read, such as a reminder for a date that has passed. The rest are known once the import has ended.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "accountImport",
                        "in": "path",
                        "required": true,
                        "description": "The id of the import. One belonging to another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to answer with.",
                        "schema": {
                            "type": "integer",
                            "default": 1
                        }
                    },
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "How many records one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused.",
                        "schema": {
                            "type": "integer",
                            "default": 25
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of the records left out, in the order the file is written. An import of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The records left out on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One record left out.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always account_import_item. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "kind": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The kind of record: contact, file, reminder, life_event, relationship and so on."
                                                            },
                                                            "source_uuid": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The id of the record in the file, or null when the file gives it none."
                                                            },
                                                            "reason": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Why it did not come over, as a sentence in the language of whoever asks."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "account_import_item",
                                            "id": "418",
                                            "attributes": {
                                                "kind": "reminder",
                                                "source_uuid": "30000000-0000-4000-8000-000000000001",
                                                "reason": "A reminder for a single date that has already passed."
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "account-imports-report-index-query",
                "tags": [
                    "Imports"
                ],
                "summary": "List what an import left out",
                "description": "List the records of the file that did not come over, and why.\n\nSome are known as soon as the file is read, such as a reminder for a date that has passed. The rest are known once the import has ended.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "accountImport",
                        "in": "path",
                        "required": true,
                        "description": "The id of the import. One belonging to another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "page": {
                                        "type": "integer",
                                        "default": 1,
                                        "description": "Which page to answer with."
                                    },
                                    "per_page": {
                                        "type": "integer",
                                        "default": 25,
                                        "description": "How many records one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "A page of the records left out, in the order the file is written. An import of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The records left out on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One record left out.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always account_import_item. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "kind": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The kind of record: contact, file, reminder, life_event, relationship and so on."
                                                            },
                                                            "source_uuid": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The id of the record in the file, or null when the file gives it none."
                                                            },
                                                            "reason": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Why it did not come over, as a sentence in the language of whoever asks."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "account_import_item",
                                            "id": "418",
                                            "attributes": {
                                                "kind": "reminder",
                                                "source_uuid": "30000000-0000-4000-8000-000000000001",
                                                "reason": "A reminder for a single date that has already passed."
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/locations": {
            "get": {
                "operationId": "locations-index",
                "tags": [
                    "Locations"
                ],
                "summary": "List locations",
                "description": "List every location of your account, each one followed by the locations inside it.\n\nA location is a place: a town, a house, a room, a shelf, a box. It belongs to the account, not to a vault, since one house holds the things of every vault.\n\nThe order is the one the settings screen shows: each location comes before the locations inside it, and the locations at each level are sorted by name. Paging slices that order, so a page may begin inside a location listed on the page before.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to answer with.",
                        "schema": {
                            "type": "integer",
                            "default": 1
                        }
                    },
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "How many locations one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused.",
                        "schema": {
                            "type": "integer",
                            "default": 25
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of location objects, and how many there are in all. An account with no location answers an empty list.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The locations on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One location.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always location. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "parent_id": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "format": "uuid",
                                                                "description": "The location it sits inside, or null at the top level."
                                                            },
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the location is called: a town, a house, a room, a shelf, a box. Two locations may share a name; the path tells them apart."
                                                            },
                                                            "emoji": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "One emoji shown in place of the default icon, or null for none."
                                                            },
                                                            "address": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The address written on the location itself, as free text over several lines, or null. Nothing geocodes it."
                                                            },
                                                            "path": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Every location from the top level down to this one, joined by \" › \". It is how a location is named wherever one is chosen."
                                                            },
                                                            "effective_address": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The address that applies to the location: its own, or else that of the nearest location around it that has one. Null when none of them has an address.",
                                                                "properties": {
                                                                    "address": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The address, as it was written."
                                                                    },
                                                                    "location_id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The location the address is written on, which is this one when it has its own."
                                                                    },
                                                                    "location_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name of that location."
                                                                    }
                                                                }
                                                            },
                                                            "location_count": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How many locations sit directly inside this one. A location holding any cannot be deleted."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the location was added, as a count of seconds since 1970 rather than a written date."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds. Equal to created_at until it is changed."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The screen where the location is edited in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "location",
                                            "id": "5b7e2c90-4d18-4a3f-9e61-0c8d2f7a1b43",
                                            "attributes": {
                                                "parent_id": null,
                                                "name": "Dunder Mifflin Scranton",
                                                "emoji": "🏢",
                                                "address": "1725 Slough Avenue\nScranton, PA 18505",
                                                "path": "Dunder Mifflin Scranton",
                                                "effective_address": {
                                                    "address": "1725 Slough Avenue\nScranton, PA 18505",
                                                    "location_id": "5b7e2c90-4d18-4a3f-9e61-0c8d2f7a1b43",
                                                    "location_name": "Dunder Mifflin Scranton"
                                                },
                                                "location_count": 1,
                                                "created_at": 1761350400,
                                                "updated_at": 1761354000
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/locations/5b7e2c90-4d18-4a3f-9e61-0c8d2f7a1b43",
                                                "web": "https://my.monicahq.com/settings/account/locations/5b7e2c90-4d18-4a3f-9e61-0c8d2f7a1b43/edit"
                                            }
                                        },
                                        {
                                            "type": "location",
                                            "id": "e83a1f6d-27c4-4b95-8d02-6f1b9c4e7a58",
                                            "attributes": {
                                                "parent_id": "5b7e2c90-4d18-4a3f-9e61-0c8d2f7a1b43",
                                                "name": "Warehouse",
                                                "emoji": "📦",
                                                "address": null,
                                                "path": "Dunder Mifflin Scranton › Warehouse",
                                                "effective_address": {
                                                    "address": "1725 Slough Avenue\nScranton, PA 18505",
                                                    "location_id": "5b7e2c90-4d18-4a3f-9e61-0c8d2f7a1b43",
                                                    "location_name": "Dunder Mifflin Scranton"
                                                },
                                                "location_count": 0,
                                                "created_at": 1761354000,
                                                "updated_at": 1761357600
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/locations/e83a1f6d-27c4-4b95-8d02-6f1b9c4e7a58",
                                                "web": "https://my.monicahq.com/settings/account/locations/e83a1f6d-27c4-4b95-8d02-6f1b9c4e7a58/edit"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 2
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "locations-index-query",
                "tags": [
                    "Locations"
                ],
                "summary": "List locations",
                "description": "List every location of your account, each one followed by the locations inside it.\n\nA location is a place: a town, a house, a room, a shelf, a box. It belongs to the account, not to a vault, since one house holds the things of every vault.\n\nThe order is the one the settings screen shows: each location comes before the locations inside it, and the locations at each level are sorted by name. Paging slices that order, so a page may begin inside a location listed on the page before.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "page": {
                                        "type": "integer",
                                        "default": 1,
                                        "description": "Which page to answer with."
                                    },
                                    "per_page": {
                                        "type": "integer",
                                        "default": 25,
                                        "description": "How many locations one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "A page of location objects, and how many there are in all. An account with no location answers an empty list.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The locations on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One location.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always location. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "parent_id": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "format": "uuid",
                                                                "description": "The location it sits inside, or null at the top level."
                                                            },
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the location is called: a town, a house, a room, a shelf, a box. Two locations may share a name; the path tells them apart."
                                                            },
                                                            "emoji": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "One emoji shown in place of the default icon, or null for none."
                                                            },
                                                            "address": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The address written on the location itself, as free text over several lines, or null. Nothing geocodes it."
                                                            },
                                                            "path": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Every location from the top level down to this one, joined by \" › \". It is how a location is named wherever one is chosen."
                                                            },
                                                            "effective_address": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The address that applies to the location: its own, or else that of the nearest location around it that has one. Null when none of them has an address.",
                                                                "properties": {
                                                                    "address": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The address, as it was written."
                                                                    },
                                                                    "location_id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The location the address is written on, which is this one when it has its own."
                                                                    },
                                                                    "location_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name of that location."
                                                                    }
                                                                }
                                                            },
                                                            "location_count": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How many locations sit directly inside this one. A location holding any cannot be deleted."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the location was added, as a count of seconds since 1970 rather than a written date."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds. Equal to created_at until it is changed."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The screen where the location is edited in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "location",
                                            "id": "5b7e2c90-4d18-4a3f-9e61-0c8d2f7a1b43",
                                            "attributes": {
                                                "parent_id": null,
                                                "name": "Dunder Mifflin Scranton",
                                                "emoji": "🏢",
                                                "address": "1725 Slough Avenue\nScranton, PA 18505",
                                                "path": "Dunder Mifflin Scranton",
                                                "effective_address": {
                                                    "address": "1725 Slough Avenue\nScranton, PA 18505",
                                                    "location_id": "5b7e2c90-4d18-4a3f-9e61-0c8d2f7a1b43",
                                                    "location_name": "Dunder Mifflin Scranton"
                                                },
                                                "location_count": 1,
                                                "created_at": 1761350400,
                                                "updated_at": 1761354000
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/locations/5b7e2c90-4d18-4a3f-9e61-0c8d2f7a1b43",
                                                "web": "https://my.monicahq.com/settings/account/locations/5b7e2c90-4d18-4a3f-9e61-0c8d2f7a1b43/edit"
                                            }
                                        },
                                        {
                                            "type": "location",
                                            "id": "e83a1f6d-27c4-4b95-8d02-6f1b9c4e7a58",
                                            "attributes": {
                                                "parent_id": "5b7e2c90-4d18-4a3f-9e61-0c8d2f7a1b43",
                                                "name": "Warehouse",
                                                "emoji": "📦",
                                                "address": null,
                                                "path": "Dunder Mifflin Scranton › Warehouse",
                                                "effective_address": {
                                                    "address": "1725 Slough Avenue\nScranton, PA 18505",
                                                    "location_id": "5b7e2c90-4d18-4a3f-9e61-0c8d2f7a1b43",
                                                    "location_name": "Dunder Mifflin Scranton"
                                                },
                                                "location_count": 0,
                                                "created_at": 1761354000,
                                                "updated_at": 1761357600
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/locations/e83a1f6d-27c4-4b95-8d02-6f1b9c4e7a58",
                                                "web": "https://my.monicahq.com/settings/account/locations/e83a1f6d-27c4-4b95-8d02-6f1b9c4e7a58/edit"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 2
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "post": {
                "operationId": "locations-create",
                "tags": [
                    "Locations"
                ],
                "summary": "Add a location",
                "description": "Add a location at the top level, or inside another one.\n\nStart with a home or a building, then add the rooms and the furniture inside it, sending the id of each as the parent_id of the next.\n\nThe change is written to the account log.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "description": "What the location is called. Up to 255 characters. Markup and surrounding blank space are stripped, and a name left with nothing in it is refused."
                                    },
                                    "parent_id": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "The location it sits inside. Null puts it at the top level, and so does leaving it out of a new location. A location of somebody else is refused, and so is the location itself or one inside it."
                                    },
                                    "emoji": {
                                        "type": "string",
                                        "description": "Exactly one emoji. A family, a flag or a skin tone counts as one. Letters, or two emoji, are refused."
                                    },
                                    "address": {
                                        "type": "string",
                                        "description": "Free text over several lines, up to 2,000 characters. Without one, the location uses the address of the nearest location around it that has one."
                                    }
                                },
                                "required": [
                                    "name"
                                ]
                            },
                            "example": {
                                "name": "Warehouse",
                                "parent_id": "5b7e2c90-4d18-4a3f-9e61-0c8d2f7a1b43",
                                "emoji": "📦"
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The location object that was added.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The location.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always location. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "parent_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The location it sits inside, or null at the top level."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the location is called: a town, a house, a room, a shelf, a box. Two locations may share a name; the path tells them apart."
                                                        },
                                                        "emoji": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One emoji shown in place of the default icon, or null for none."
                                                        },
                                                        "address": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The address written on the location itself, as free text over several lines, or null. Nothing geocodes it."
                                                        },
                                                        "path": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Every location from the top level down to this one, joined by \" › \". It is how a location is named wherever one is chosen."
                                                        },
                                                        "effective_address": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The address that applies to the location: its own, or else that of the nearest location around it that has one. Null when none of them has an address.",
                                                            "properties": {
                                                                "address": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The address, as it was written."
                                                                },
                                                                "location_id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The location the address is written on, which is this one when it has its own."
                                                                },
                                                                "location_name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The name of that location."
                                                                }
                                                            }
                                                        },
                                                        "location_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many locations sit directly inside this one. A location holding any cannot be deleted."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the location was added, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it is changed."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The screen where the location is edited in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "location",
                                        "id": "e83a1f6d-27c4-4b95-8d02-6f1b9c4e7a58",
                                        "attributes": {
                                            "parent_id": "5b7e2c90-4d18-4a3f-9e61-0c8d2f7a1b43",
                                            "name": "Warehouse",
                                            "emoji": "📦",
                                            "address": null,
                                            "path": "Dunder Mifflin Scranton › Warehouse",
                                            "effective_address": {
                                                "address": "1725 Slough Avenue\nScranton, PA 18505",
                                                "location_id": "5b7e2c90-4d18-4a3f-9e61-0c8d2f7a1b43",
                                                "location_name": "Dunder Mifflin Scranton"
                                            },
                                            "location_count": 0,
                                            "created_at": 1761354000,
                                            "updated_at": 1761357600
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/locations/e83a1f6d-27c4-4b95-8d02-6f1b9c4e7a58",
                                            "web": "https://my.monicahq.com/settings/account/locations/e83a1f6d-27c4-4b95-8d02-6f1b9c4e7a58/edit"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/locations/{location}": {
            "get": {
                "operationId": "locations-show",
                "tags": [
                    "Locations"
                ],
                "summary": "Get a location",
                "description": "Retrieve one location, its full path and the address that applies to it.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "location",
                        "in": "path",
                        "required": true,
                        "description": "The id of the location. A location belonging to somebody else answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A location object. A location belonging to somebody else answers 404, which is also what a location that never existed answers.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The location.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always location. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "parent_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The location it sits inside, or null at the top level."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the location is called: a town, a house, a room, a shelf, a box. Two locations may share a name; the path tells them apart."
                                                        },
                                                        "emoji": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One emoji shown in place of the default icon, or null for none."
                                                        },
                                                        "address": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The address written on the location itself, as free text over several lines, or null. Nothing geocodes it."
                                                        },
                                                        "path": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Every location from the top level down to this one, joined by \" › \". It is how a location is named wherever one is chosen."
                                                        },
                                                        "effective_address": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The address that applies to the location: its own, or else that of the nearest location around it that has one. Null when none of them has an address.",
                                                            "properties": {
                                                                "address": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The address, as it was written."
                                                                },
                                                                "location_id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The location the address is written on, which is this one when it has its own."
                                                                },
                                                                "location_name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The name of that location."
                                                                }
                                                            }
                                                        },
                                                        "location_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many locations sit directly inside this one. A location holding any cannot be deleted."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the location was added, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it is changed."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The screen where the location is edited in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "location",
                                        "id": "e83a1f6d-27c4-4b95-8d02-6f1b9c4e7a58",
                                        "attributes": {
                                            "parent_id": "5b7e2c90-4d18-4a3f-9e61-0c8d2f7a1b43",
                                            "name": "Warehouse",
                                            "emoji": "📦",
                                            "address": null,
                                            "path": "Dunder Mifflin Scranton › Warehouse",
                                            "effective_address": {
                                                "address": "1725 Slough Avenue\nScranton, PA 18505",
                                                "location_id": "5b7e2c90-4d18-4a3f-9e61-0c8d2f7a1b43",
                                                "location_name": "Dunder Mifflin Scranton"
                                            },
                                            "location_count": 0,
                                            "created_at": 1761354000,
                                            "updated_at": 1761357600
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/locations/e83a1f6d-27c4-4b95-8d02-6f1b9c4e7a58",
                                            "web": "https://my.monicahq.com/settings/account/locations/e83a1f6d-27c4-4b95-8d02-6f1b9c4e7a58/edit"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "locations-show-query",
                "tags": [
                    "Locations"
                ],
                "summary": "Get a location",
                "description": "Retrieve one location, its full path and the address that applies to it.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "location",
                        "in": "path",
                        "required": true,
                        "description": "The id of the location. A location belonging to somebody else answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A location object. A location belonging to somebody else answers 404, which is also what a location that never existed answers.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The location.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always location. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "parent_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The location it sits inside, or null at the top level."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the location is called: a town, a house, a room, a shelf, a box. Two locations may share a name; the path tells them apart."
                                                        },
                                                        "emoji": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One emoji shown in place of the default icon, or null for none."
                                                        },
                                                        "address": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The address written on the location itself, as free text over several lines, or null. Nothing geocodes it."
                                                        },
                                                        "path": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Every location from the top level down to this one, joined by \" › \". It is how a location is named wherever one is chosen."
                                                        },
                                                        "effective_address": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The address that applies to the location: its own, or else that of the nearest location around it that has one. Null when none of them has an address.",
                                                            "properties": {
                                                                "address": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The address, as it was written."
                                                                },
                                                                "location_id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The location the address is written on, which is this one when it has its own."
                                                                },
                                                                "location_name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The name of that location."
                                                                }
                                                            }
                                                        },
                                                        "location_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many locations sit directly inside this one. A location holding any cannot be deleted."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the location was added, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it is changed."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The screen where the location is edited in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "location",
                                        "id": "e83a1f6d-27c4-4b95-8d02-6f1b9c4e7a58",
                                        "attributes": {
                                            "parent_id": "5b7e2c90-4d18-4a3f-9e61-0c8d2f7a1b43",
                                            "name": "Warehouse",
                                            "emoji": "📦",
                                            "address": null,
                                            "path": "Dunder Mifflin Scranton › Warehouse",
                                            "effective_address": {
                                                "address": "1725 Slough Avenue\nScranton, PA 18505",
                                                "location_id": "5b7e2c90-4d18-4a3f-9e61-0c8d2f7a1b43",
                                                "location_name": "Dunder Mifflin Scranton"
                                            },
                                            "location_count": 0,
                                            "created_at": 1761354000,
                                            "updated_at": 1761357600
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/locations/e83a1f6d-27c4-4b95-8d02-6f1b9c4e7a58",
                                            "web": "https://my.monicahq.com/settings/account/locations/e83a1f6d-27c4-4b95-8d02-6f1b9c4e7a58/edit"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "put": {
                "operationId": "locations-update",
                "tags": [
                    "Locations"
                ],
                "summary": "Change a location",
                "description": "Rename a location, move it inside another one or to the top level, or change its emoji or its address.\n\nSend only what changes. A name sent as null is refused with 422. A parent_id sent as null moves the location to the top level, and an emoji or an address sent as null is cleared.\n\nEverything inside the location moves with it, and every path containing it changes. A parent that is the location itself or one inside it, at any depth, answers 422 on parent_id: \"A location cannot sit inside itself, or inside a location it holds.\"\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "location",
                        "in": "path",
                        "required": true,
                        "description": "The id of the location. A location belonging to somebody else answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "description": "What the location is called. Up to 255 characters. Markup and surrounding blank space are stripped, and a name left with nothing in it is refused."
                                    },
                                    "parent_id": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "The location it sits inside. Null puts it at the top level, and so does leaving it out of a new location. A location of somebody else is refused, and so is the location itself or one inside it."
                                    },
                                    "emoji": {
                                        "type": "string",
                                        "description": "Exactly one emoji. A family, a flag or a skin tone counts as one. Letters, or two emoji, are refused."
                                    },
                                    "address": {
                                        "type": "string",
                                        "description": "Free text over several lines, up to 2,000 characters. Without one, the location uses the address of the nearest location around it that has one."
                                    }
                                }
                            },
                            "example": {
                                "name": "Warehouse",
                                "parent_id": "5b7e2c90-4d18-4a3f-9e61-0c8d2f7a1b43",
                                "emoji": "📦"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The location object as it now reads.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The location.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always location. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "parent_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The location it sits inside, or null at the top level."
                                                        },
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the location is called: a town, a house, a room, a shelf, a box. Two locations may share a name; the path tells them apart."
                                                        },
                                                        "emoji": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One emoji shown in place of the default icon, or null for none."
                                                        },
                                                        "address": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The address written on the location itself, as free text over several lines, or null. Nothing geocodes it."
                                                        },
                                                        "path": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Every location from the top level down to this one, joined by \" › \". It is how a location is named wherever one is chosen."
                                                        },
                                                        "effective_address": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The address that applies to the location: its own, or else that of the nearest location around it that has one. Null when none of them has an address.",
                                                            "properties": {
                                                                "address": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The address, as it was written."
                                                                },
                                                                "location_id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The location the address is written on, which is this one when it has its own."
                                                                },
                                                                "location_name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The name of that location."
                                                                }
                                                            }
                                                        },
                                                        "location_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many locations sit directly inside this one. A location holding any cannot be deleted."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the location was added, as a count of seconds since 1970 rather than a written date."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds. Equal to created_at until it is changed."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The screen where the location is edited in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "location",
                                        "id": "e83a1f6d-27c4-4b95-8d02-6f1b9c4e7a58",
                                        "attributes": {
                                            "parent_id": "5b7e2c90-4d18-4a3f-9e61-0c8d2f7a1b43",
                                            "name": "Warehouse",
                                            "emoji": "📦",
                                            "address": null,
                                            "path": "Dunder Mifflin Scranton › Warehouse",
                                            "effective_address": {
                                                "address": "1725 Slough Avenue\nScranton, PA 18505",
                                                "location_id": "5b7e2c90-4d18-4a3f-9e61-0c8d2f7a1b43",
                                                "location_name": "Dunder Mifflin Scranton"
                                            },
                                            "location_count": 0,
                                            "created_at": 1761354000,
                                            "updated_at": 1761357600
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/locations/e83a1f6d-27c4-4b95-8d02-6f1b9c4e7a58",
                                            "web": "https://my.monicahq.com/settings/account/locations/e83a1f6d-27c4-4b95-8d02-6f1b9c4e7a58/edit"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "delete": {
                "operationId": "locations-destroy",
                "tags": [
                    "Locations"
                ],
                "summary": "Delete a location",
                "description": "Remove a location that holds no other and that no possession has stayed at.\n\nA location holding others answers 422 on location, saying how many and that they must be moved first, for instance \"1 location is inside it. Move it first.\" Nothing is moved on your behalf.\n\nA location any stay of a possession refers to, current or past, answers 422 on location as well, for instance \"1 stay of a possession is here. Correct or delete it first.\" The history of a possession is never lost on your behalf.\n\nThe deletion is final, and the account log keeps the name of the location.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "location",
                        "in": "path",
                        "required": true,
                        "description": "The id of the location. A location belonging to somebody else answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Nothing. A location holding others or referred to by a stay answers 422, and one belonging to somebody else answers 404."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/exports": {
            "get": {
                "operationId": "account-exports-index",
                "tags": [
                    "Exports"
                ],
                "summary": "List exports",
                "description": "List the exports of the account, the newest first, including the ones that failed or expired.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to answer with.",
                        "schema": {
                            "type": "integer",
                            "default": 1
                        }
                    },
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "How many records one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused.",
                        "schema": {
                            "type": "integer",
                            "default": 25
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of export objects, the newest first.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The exports on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One export.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always account_export. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "status": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Where the export stands: preparing, ready, failed or expired. The file is prepared in the background, and an email says when it is ready."
                                                            },
                                                            "vaults": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "The vaults the file holds.",
                                                                "items": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of one of those vaults. A vault deleted since the export was asked for is left out."
                                                                }
                                                            },
                                                            "size_in_bytes": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "The size of the file in bytes, or null until it is ready."
                                                            },
                                                            "ready_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the file was complete, as a count of seconds since 1970, or null until it is ready."
                                                            },
                                                            "expires_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the file is deleted, seven days after it was ready unless a newer export of the account is ready first, as a count of seconds since 1970, or null until it is ready. From that moment it can no longer be downloaded."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the export was asked for, as a count of seconds since 1970."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "account_export",
                                            "id": "e7a1d9c4-3b6f-4f2a-8d15-6c0b9e2a4f73",
                                            "attributes": {
                                                "status": "ready",
                                                "vaults": [
                                                    "9b2d4f6a-1e3c-4a5b-8c7d-0f1e2d3c4b5a",
                                                    "c4e6a8b0-2d4f-4a6b-9c8d-1e3f5a7b9c0d"
                                                ],
                                                "size_in_bytes": 18734522,
                                                "ready_at": 1792310700,
                                                "expires_at": 1792915500,
                                                "created_at": 1792310400
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/exports/e7a1d9c4-3b6f-4f2a-8d15-6c0b9e2a4f73"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "account-exports-index-query",
                "tags": [
                    "Exports"
                ],
                "summary": "List exports",
                "description": "List the exports of the account, the newest first, including the ones that failed or expired.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "page": {
                                        "type": "integer",
                                        "default": 1,
                                        "description": "Which page to answer with."
                                    },
                                    "per_page": {
                                        "type": "integer",
                                        "default": 25,
                                        "description": "How many records one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "A page of export objects, the newest first.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The exports on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One export.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always account_export. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "status": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Where the export stands: preparing, ready, failed or expired. The file is prepared in the background, and an email says when it is ready."
                                                            },
                                                            "vaults": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "The vaults the file holds.",
                                                                "items": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of one of those vaults. A vault deleted since the export was asked for is left out."
                                                                }
                                                            },
                                                            "size_in_bytes": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "The size of the file in bytes, or null until it is ready."
                                                            },
                                                            "ready_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the file was complete, as a count of seconds since 1970, or null until it is ready."
                                                            },
                                                            "expires_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the file is deleted, seven days after it was ready unless a newer export of the account is ready first, as a count of seconds since 1970, or null until it is ready. From that moment it can no longer be downloaded."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the export was asked for, as a count of seconds since 1970."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "account_export",
                                            "id": "e7a1d9c4-3b6f-4f2a-8d15-6c0b9e2a4f73",
                                            "attributes": {
                                                "status": "ready",
                                                "vaults": [
                                                    "9b2d4f6a-1e3c-4a5b-8c7d-0f1e2d3c4b5a",
                                                    "c4e6a8b0-2d4f-4a6b-9c8d-1e3f5a7b9c0d"
                                                ],
                                                "size_in_bytes": 18734522,
                                                "ready_at": 1792310700,
                                                "expires_at": 1792915500,
                                                "created_at": 1792310400
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/exports/e7a1d9c4-3b6f-4f2a-8d15-6c0b9e2a4f73"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "post": {
                "operationId": "account-exports-create",
                "tags": [
                    "Exports"
                ],
                "summary": "Export the account",
                "description": "Ask for a file holding everything in the chosen vaults, or in every vault of the account.\n\nThe file holds every contact, value, relationship, life event, reminder and file of those vaults, sensitive fields included, and it is not encrypted. Only a key holding the sensitive fields scope can ask for one: any other key answers 403. A key minted for everything does not count, the scope has to be asked for by name.\n\nThe file is prepared in the background. Ask for the export until its status is ready, then download it with GET /exports/{accountExport}/download.\n\nAn account prepares one export at a time. Asking for another while one is being prepared answers 422.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "vaults": {
                                        "type": "array",
                                        "description": "The vaults to put in the file, each named by its slug or its id. Leave it out to export every vault of the account. An empty list answers 422, and a vault of another account answers 404."
                                    }
                                }
                            },
                            "example": {
                                "vaults": [
                                    "9b2d4f6a-1e3c-4a5b-8c7d-0f1e2d3c4b5a"
                                ]
                            }
                        }
                    }
                },
                "responses": {
                    "202": {
                        "description": "The export object, being prepared.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The export.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always account_export. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the export stands: preparing, ready, failed or expired. The file is prepared in the background, and an email says when it is ready."
                                                        },
                                                        "vaults": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The vaults the file holds.",
                                                            "items": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "format": "uuid",
                                                                "description": "The id of one of those vaults. A vault deleted since the export was asked for is left out."
                                                            }
                                                        },
                                                        "size_in_bytes": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The size of the file in bytes, or null until it is ready."
                                                        },
                                                        "ready_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the file was complete, as a count of seconds since 1970, or null until it is ready."
                                                        },
                                                        "expires_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the file is deleted, seven days after it was ready unless a newer export of the account is ready first, as a count of seconds since 1970, or null until it is ready. From that moment it can no longer be downloaded."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the export was asked for, as a count of seconds since 1970."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "account_export",
                                        "id": "e7a1d9c4-3b6f-4f2a-8d15-6c0b9e2a4f73",
                                        "attributes": {
                                            "status": "preparing",
                                            "vaults": [
                                                "9b2d4f6a-1e3c-4a5b-8c7d-0f1e2d3c4b5a",
                                                "c4e6a8b0-2d4f-4a6b-9c8d-1e3f5a7b9c0d"
                                            ],
                                            "size_in_bytes": null,
                                            "ready_at": null,
                                            "expires_at": null,
                                            "created_at": 1792310400
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/exports/e7a1d9c4-3b6f-4f2a-8d15-6c0b9e2a4f73"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/exports/{accountExport}": {
            "get": {
                "operationId": "account-exports-show",
                "tags": [
                    "Exports"
                ],
                "summary": "Get an export",
                "description": "Retrieve one export, to follow it until its file is ready.\n\nAn export moves on its own, in the background, while its status is preparing. Ask again to follow it. An email says when it is ready.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "accountExport",
                        "in": "path",
                        "required": true,
                        "description": "The id of the export. One belonging to another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "An export object. One of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The export.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always account_export. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the export stands: preparing, ready, failed or expired. The file is prepared in the background, and an email says when it is ready."
                                                        },
                                                        "vaults": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The vaults the file holds.",
                                                            "items": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "format": "uuid",
                                                                "description": "The id of one of those vaults. A vault deleted since the export was asked for is left out."
                                                            }
                                                        },
                                                        "size_in_bytes": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The size of the file in bytes, or null until it is ready."
                                                        },
                                                        "ready_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the file was complete, as a count of seconds since 1970, or null until it is ready."
                                                        },
                                                        "expires_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the file is deleted, seven days after it was ready unless a newer export of the account is ready first, as a count of seconds since 1970, or null until it is ready. From that moment it can no longer be downloaded."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the export was asked for, as a count of seconds since 1970."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "account_export",
                                        "id": "e7a1d9c4-3b6f-4f2a-8d15-6c0b9e2a4f73",
                                        "attributes": {
                                            "status": "ready",
                                            "vaults": [
                                                "9b2d4f6a-1e3c-4a5b-8c7d-0f1e2d3c4b5a",
                                                "c4e6a8b0-2d4f-4a6b-9c8d-1e3f5a7b9c0d"
                                            ],
                                            "size_in_bytes": 18734522,
                                            "ready_at": 1792310700,
                                            "expires_at": 1792915500,
                                            "created_at": 1792310400
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/exports/e7a1d9c4-3b6f-4f2a-8d15-6c0b9e2a4f73"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "account-exports-show-query",
                "tags": [
                    "Exports"
                ],
                "summary": "Get an export",
                "description": "Retrieve one export, to follow it until its file is ready.\n\nAn export moves on its own, in the background, while its status is preparing. Ask again to follow it. An email says when it is ready.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "accountExport",
                        "in": "path",
                        "required": true,
                        "description": "The id of the export. One belonging to another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "An export object. One of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The export.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always account_export. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the export stands: preparing, ready, failed or expired. The file is prepared in the background, and an email says when it is ready."
                                                        },
                                                        "vaults": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The vaults the file holds.",
                                                            "items": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "format": "uuid",
                                                                "description": "The id of one of those vaults. A vault deleted since the export was asked for is left out."
                                                            }
                                                        },
                                                        "size_in_bytes": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The size of the file in bytes, or null until it is ready."
                                                        },
                                                        "ready_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the file was complete, as a count of seconds since 1970, or null until it is ready."
                                                        },
                                                        "expires_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the file is deleted, seven days after it was ready unless a newer export of the account is ready first, as a count of seconds since 1970, or null until it is ready. From that moment it can no longer be downloaded."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the export was asked for, as a count of seconds since 1970."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "account_export",
                                        "id": "e7a1d9c4-3b6f-4f2a-8d15-6c0b9e2a4f73",
                                        "attributes": {
                                            "status": "ready",
                                            "vaults": [
                                                "9b2d4f6a-1e3c-4a5b-8c7d-0f1e2d3c4b5a",
                                                "c4e6a8b0-2d4f-4a6b-9c8d-1e3f5a7b9c0d"
                                            ],
                                            "size_in_bytes": 18734522,
                                            "ready_at": 1792310700,
                                            "expires_at": 1792915500,
                                            "created_at": 1792310400
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/exports/e7a1d9c4-3b6f-4f2a-8d15-6c0b9e2a4f73"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/exports/{accountExport}/download": {
            "get": {
                "operationId": "account-exports-download",
                "tags": [
                    "Exports"
                ],
                "summary": "Download an export",
                "description": "Retrieve the file of an export that is ready.\n\nThe body is the file itself, one JSON document with a file name attached, so what you receive can be written straight to disk. It is not wrapped in data like the other answers here. Its top level holds version (2.0-preview.1), app_version, exported_at and account, and account holds the vaults with everything in them.\n\nOnly a key holding the sensitive fields scope can download the file, since it holds every sensitive value: any other key answers 403.\n\nAn export that is not ready, or whose expires_at has passed, answers 404. Each download is written to the log of the account.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "accountExport",
                        "in": "path",
                        "required": true,
                        "description": "The id of the export. One belonging to another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The file, as JSON. An export of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object"
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "account-exports-download-query",
                "tags": [
                    "Exports"
                ],
                "summary": "Download an export",
                "description": "Retrieve the file of an export that is ready.\n\nThe body is the file itself, one JSON document with a file name attached, so what you receive can be written straight to disk. It is not wrapped in data like the other answers here. Its top level holds version (2.0-preview.1), app_version, exported_at and account, and account holds the vaults with everything in them.\n\nOnly a key holding the sensitive fields scope can download the file, since it holds every sensitive value: any other key answers 403.\n\nAn export that is not ready, or whose expires_at has passed, answers 404. Each download is written to the log of the account.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "accountExport",
                        "in": "path",
                        "required": true,
                        "description": "The id of the export. One belonging to another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The file, as JSON. An export of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object"
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/possession-types": {
            "get": {
                "operationId": "possession-types-index",
                "tags": [
                    "Possession types"
                ],
                "summary": "List possession types",
                "description": "List every possession type of your account, sorted by name, each with its groups and fields in order.\n\nA possession type belongs to the account, not to a vault, as locations do.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to answer with.",
                        "schema": {
                            "type": "integer",
                            "default": 1
                        }
                    },
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "How many types one page holds, between 1 and 100. A number outside the range is brought back into it.",
                        "schema": {
                            "type": "integer",
                            "default": 25
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of possession type objects, and how many there are in all. An account with none answers an empty list.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The possession types on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One possession type.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always possession_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the kind of thing is called: office equipment, a vehicle, a musical instrument."
                                                            },
                                                            "colour": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "One of the eight vault colours, as a hexadecimal value."
                                                            },
                                                            "icon": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "One of the glyphs of the catalogue (the same list sections and possession conditions use), or null. A type without one is drawn with a blank page."
                                                            },
                                                            "field_count": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How many fields the type has, grouped or not."
                                                            },
                                                            "groups": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "The groups of fields, in order.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One group.",
                                                                    "properties": {
                                                                        "id": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "format": "uuid",
                                                                            "description": "The id of the group."
                                                                        },
                                                                        "name": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "What the group is called, such as Purchase."
                                                                        },
                                                                        "position": {
                                                                            "type": [
                                                                                "integer",
                                                                                "null"
                                                                            ],
                                                                            "description": "Its place among the groups, counting from 1."
                                                                        },
                                                                        "fields": {
                                                                            "type": [
                                                                                "array",
                                                                                "null"
                                                                            ],
                                                                            "description": "The fields of the group, in order.",
                                                                            "items": {
                                                                                "type": [
                                                                                    "object",
                                                                                    "null"
                                                                                ],
                                                                                "description": "One field.",
                                                                                "properties": {
                                                                                    "id": {
                                                                                        "type": [
                                                                                            "string",
                                                                                            "null"
                                                                                        ],
                                                                                        "format": "uuid",
                                                                                        "description": "The id of the field."
                                                                                    },
                                                                                    "name": {
                                                                                        "type": [
                                                                                            "string",
                                                                                            "null"
                                                                                        ],
                                                                                        "description": "What the field is called, such as Serial number."
                                                                                    },
                                                                                    "kind": {
                                                                                        "type": [
                                                                                            "string",
                                                                                            "null"
                                                                                        ],
                                                                                        "description": "What the field holds: text, number, date, boolean, select, or rating from one to five."
                                                                                    },
                                                                                    "options": {
                                                                                        "type": [
                                                                                            "array",
                                                                                            "null"
                                                                                        ],
                                                                                        "description": "The choices of a select field, in order, or null for every other kind.",
                                                                                        "items": {
                                                                                            "type": [
                                                                                                "string",
                                                                                                "null"
                                                                                            ],
                                                                                            "description": "One choice."
                                                                                        }
                                                                                    },
                                                                                    "position": {
                                                                                        "type": [
                                                                                            "integer",
                                                                                            "null"
                                                                                        ],
                                                                                        "description": "Its place among its siblings, counting from 1."
                                                                                    },
                                                                                    "group_id": {
                                                                                        "type": [
                                                                                            "string",
                                                                                            "null"
                                                                                        ],
                                                                                        "format": "uuid",
                                                                                        "description": "The group it sits in, or null when it stands alone."
                                                                                    }
                                                                                }
                                                                            }
                                                                        }
                                                                    }
                                                                }
                                                            },
                                                            "fields": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "The fields standing outside any group, in order.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One field.",
                                                                    "properties": {
                                                                        "id": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "format": "uuid",
                                                                            "description": "The id of the field."
                                                                        },
                                                                        "name": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "What the field is called, such as Serial number."
                                                                        },
                                                                        "kind": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "What the field holds: text, number, date, boolean, select, or rating from one to five."
                                                                        },
                                                                        "options": {
                                                                            "type": [
                                                                                "array",
                                                                                "null"
                                                                            ],
                                                                            "description": "The choices of a select field, in order, or null for every other kind.",
                                                                            "items": {
                                                                                "type": [
                                                                                    "string",
                                                                                    "null"
                                                                                ],
                                                                                "description": "One choice."
                                                                            }
                                                                        },
                                                                        "position": {
                                                                            "type": [
                                                                                "integer",
                                                                                "null"
                                                                            ],
                                                                            "description": "Its place among its siblings, counting from 1."
                                                                        },
                                                                        "group_id": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "format": "uuid",
                                                                            "description": "The group it sits in, or null when it stands alone."
                                                                        }
                                                                    }
                                                                }
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the type was added, as a count of seconds since 1970."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When its name, colour or icon last changed, as a count of seconds, or null."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The screen where the possession type is edited in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "possession_type",
                                            "id": "9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35",
                                            "attributes": {
                                                "name": "Office equipment",
                                                "colour": "#2f7f86",
                                                "icon": "briefcase",
                                                "field_count": 3,
                                                "groups": [
                                                    {
                                                        "id": "4f2a8c61-7d93-4e05-b1c8-93a6d5e20b17",
                                                        "name": "Purchase",
                                                        "position": 1,
                                                        "fields": [
                                                            {
                                                                "id": "b7e04a93-1c6f-4d28-9a35-6f8e2d1c4b90",
                                                                "name": "Payment method",
                                                                "kind": "select",
                                                                "options": [
                                                                    "Cash",
                                                                    "Card"
                                                                ],
                                                                "position": 1,
                                                                "group_id": "4f2a8c61-7d93-4e05-b1c8-93a6d5e20b17"
                                                            }
                                                        ]
                                                    }
                                                ],
                                                "fields": [
                                                    {
                                                        "id": "e5c37a28-9f14-4b6d-a083-7d2e1f9b6c45",
                                                        "name": "Condition",
                                                        "kind": "select",
                                                        "options": [
                                                            "New",
                                                            "Used",
                                                            "Broken"
                                                        ],
                                                        "position": 1,
                                                        "group_id": null
                                                    },
                                                    {
                                                        "id": "2d8b5f1e-6a47-4c93-8e02-1b9f7c3a5d64",
                                                        "name": "Serial number",
                                                        "kind": "text",
                                                        "options": null,
                                                        "position": 2,
                                                        "group_id": null
                                                    }
                                                ],
                                                "created_at": 1761436800,
                                                "updated_at": 1761440400
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/possession-types/9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35",
                                                "web": "https://my.monicahq.com/settings/account/possession-types/9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35/edit"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "possession-types-index-query",
                "tags": [
                    "Possession types"
                ],
                "summary": "List possession types",
                "description": "List every possession type of your account, sorted by name, each with its groups and fields in order.\n\nA possession type belongs to the account, not to a vault, as locations do.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "page": {
                                        "type": "integer",
                                        "default": 1,
                                        "description": "Which page to answer with."
                                    },
                                    "per_page": {
                                        "type": "integer",
                                        "default": 25,
                                        "description": "How many types one page holds, between 1 and 100. A number outside the range is brought back into it."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "A page of possession type objects, and how many there are in all. An account with none answers an empty list.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The possession types on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One possession type.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always possession_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the kind of thing is called: office equipment, a vehicle, a musical instrument."
                                                            },
                                                            "colour": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "One of the eight vault colours, as a hexadecimal value."
                                                            },
                                                            "icon": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "One of the glyphs of the catalogue (the same list sections and possession conditions use), or null. A type without one is drawn with a blank page."
                                                            },
                                                            "field_count": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How many fields the type has, grouped or not."
                                                            },
                                                            "groups": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "The groups of fields, in order.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One group.",
                                                                    "properties": {
                                                                        "id": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "format": "uuid",
                                                                            "description": "The id of the group."
                                                                        },
                                                                        "name": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "What the group is called, such as Purchase."
                                                                        },
                                                                        "position": {
                                                                            "type": [
                                                                                "integer",
                                                                                "null"
                                                                            ],
                                                                            "description": "Its place among the groups, counting from 1."
                                                                        },
                                                                        "fields": {
                                                                            "type": [
                                                                                "array",
                                                                                "null"
                                                                            ],
                                                                            "description": "The fields of the group, in order.",
                                                                            "items": {
                                                                                "type": [
                                                                                    "object",
                                                                                    "null"
                                                                                ],
                                                                                "description": "One field.",
                                                                                "properties": {
                                                                                    "id": {
                                                                                        "type": [
                                                                                            "string",
                                                                                            "null"
                                                                                        ],
                                                                                        "format": "uuid",
                                                                                        "description": "The id of the field."
                                                                                    },
                                                                                    "name": {
                                                                                        "type": [
                                                                                            "string",
                                                                                            "null"
                                                                                        ],
                                                                                        "description": "What the field is called, such as Serial number."
                                                                                    },
                                                                                    "kind": {
                                                                                        "type": [
                                                                                            "string",
                                                                                            "null"
                                                                                        ],
                                                                                        "description": "What the field holds: text, number, date, boolean, select, or rating from one to five."
                                                                                    },
                                                                                    "options": {
                                                                                        "type": [
                                                                                            "array",
                                                                                            "null"
                                                                                        ],
                                                                                        "description": "The choices of a select field, in order, or null for every other kind.",
                                                                                        "items": {
                                                                                            "type": [
                                                                                                "string",
                                                                                                "null"
                                                                                            ],
                                                                                            "description": "One choice."
                                                                                        }
                                                                                    },
                                                                                    "position": {
                                                                                        "type": [
                                                                                            "integer",
                                                                                            "null"
                                                                                        ],
                                                                                        "description": "Its place among its siblings, counting from 1."
                                                                                    },
                                                                                    "group_id": {
                                                                                        "type": [
                                                                                            "string",
                                                                                            "null"
                                                                                        ],
                                                                                        "format": "uuid",
                                                                                        "description": "The group it sits in, or null when it stands alone."
                                                                                    }
                                                                                }
                                                                            }
                                                                        }
                                                                    }
                                                                }
                                                            },
                                                            "fields": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "The fields standing outside any group, in order.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One field.",
                                                                    "properties": {
                                                                        "id": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "format": "uuid",
                                                                            "description": "The id of the field."
                                                                        },
                                                                        "name": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "What the field is called, such as Serial number."
                                                                        },
                                                                        "kind": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "What the field holds: text, number, date, boolean, select, or rating from one to five."
                                                                        },
                                                                        "options": {
                                                                            "type": [
                                                                                "array",
                                                                                "null"
                                                                            ],
                                                                            "description": "The choices of a select field, in order, or null for every other kind.",
                                                                            "items": {
                                                                                "type": [
                                                                                    "string",
                                                                                    "null"
                                                                                ],
                                                                                "description": "One choice."
                                                                            }
                                                                        },
                                                                        "position": {
                                                                            "type": [
                                                                                "integer",
                                                                                "null"
                                                                            ],
                                                                            "description": "Its place among its siblings, counting from 1."
                                                                        },
                                                                        "group_id": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "format": "uuid",
                                                                            "description": "The group it sits in, or null when it stands alone."
                                                                        }
                                                                    }
                                                                }
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the type was added, as a count of seconds since 1970."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When its name, colour or icon last changed, as a count of seconds, or null."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The screen where the possession type is edited in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "possession_type",
                                            "id": "9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35",
                                            "attributes": {
                                                "name": "Office equipment",
                                                "colour": "#2f7f86",
                                                "icon": "briefcase",
                                                "field_count": 3,
                                                "groups": [
                                                    {
                                                        "id": "4f2a8c61-7d93-4e05-b1c8-93a6d5e20b17",
                                                        "name": "Purchase",
                                                        "position": 1,
                                                        "fields": [
                                                            {
                                                                "id": "b7e04a93-1c6f-4d28-9a35-6f8e2d1c4b90",
                                                                "name": "Payment method",
                                                                "kind": "select",
                                                                "options": [
                                                                    "Cash",
                                                                    "Card"
                                                                ],
                                                                "position": 1,
                                                                "group_id": "4f2a8c61-7d93-4e05-b1c8-93a6d5e20b17"
                                                            }
                                                        ]
                                                    }
                                                ],
                                                "fields": [
                                                    {
                                                        "id": "e5c37a28-9f14-4b6d-a083-7d2e1f9b6c45",
                                                        "name": "Condition",
                                                        "kind": "select",
                                                        "options": [
                                                            "New",
                                                            "Used",
                                                            "Broken"
                                                        ],
                                                        "position": 1,
                                                        "group_id": null
                                                    },
                                                    {
                                                        "id": "2d8b5f1e-6a47-4c93-8e02-1b9f7c3a5d64",
                                                        "name": "Serial number",
                                                        "kind": "text",
                                                        "options": null,
                                                        "position": 2,
                                                        "group_id": null
                                                    }
                                                ],
                                                "created_at": 1761436800,
                                                "updated_at": 1761440400
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/possession-types/9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35",
                                                "web": "https://my.monicahq.com/settings/account/possession-types/9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35/edit"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "post": {
                "operationId": "possession-types-create",
                "tags": [
                    "Possession types"
                ],
                "summary": "Add a possession type",
                "description": "Add a kind of thing your account owns. Add its groups and fields afterwards.\n\nThe change is written to the account log.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "description": "What the kind of thing is called. Up to 255 characters. Markup and surrounding blank space are stripped, and a name left with nothing in it is refused."
                                    },
                                    "colour": {
                                        "type": "string",
                                        "description": "One of the vault colours: #3f5fd0, #4f8a49, #9a6a24, #9a3f2b, #6b4fa8, #2f7f86, #a8447a or #4a4a52. Blue when left out."
                                    },
                                    "icon": {
                                        "type": "string",
                                        "description": "One of the glyphs of the catalogue. Anything else answers 422. None when left out."
                                    }
                                },
                                "required": [
                                    "name"
                                ]
                            },
                            "example": {
                                "name": "Office equipment",
                                "colour": "#2f7f86",
                                "icon": "briefcase"
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The possession type object that was added, with no group and no field yet.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession type.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the kind of thing is called."
                                                        },
                                                        "colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of the eight vault colours, as a hexadecimal value."
                                                        },
                                                        "icon": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of the glyphs of the catalogue (the same list sections and possession conditions use), or null. A type without one is drawn with a blank page."
                                                        },
                                                        "field_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many fields the type has, which is 0 for a new one."
                                                        },
                                                        "groups": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The groups of fields, an empty list for a new type."
                                                        },
                                                        "fields": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The standalone fields, an empty list for a new type."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the type was added, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The screen where the possession type is edited in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_type",
                                        "id": "9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35",
                                        "attributes": {
                                            "name": "Office equipment",
                                            "colour": "#2f7f86",
                                            "icon": "briefcase",
                                            "field_count": 0,
                                            "groups": [],
                                            "fields": [],
                                            "created_at": 1761436800,
                                            "updated_at": 1761436800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/possession-types/9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35",
                                            "web": "https://my.monicahq.com/settings/account/possession-types/9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35/edit"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/possession-types/{possessionType}": {
            "get": {
                "operationId": "possession-types-show",
                "tags": [
                    "Possession types"
                ],
                "summary": "Get a possession type",
                "description": "Retrieve one possession type with its groups and fields.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "possessionType",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession type. A type belonging to somebody else answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A possession type object. A type belonging to somebody else answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession type.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the kind of thing is called: office equipment, a vehicle, a musical instrument."
                                                        },
                                                        "colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of the eight vault colours, as a hexadecimal value."
                                                        },
                                                        "icon": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of the glyphs of the catalogue (the same list sections and possession conditions use), or null. A type without one is drawn with a blank page."
                                                        },
                                                        "field_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many fields the type has, grouped or not."
                                                        },
                                                        "groups": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The groups of fields, in order.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One group.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the group."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the group is called, such as Purchase."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Its place among the groups, counting from 1."
                                                                    },
                                                                    "fields": {
                                                                        "type": [
                                                                            "array",
                                                                            "null"
                                                                        ],
                                                                        "description": "The fields of the group, in order.",
                                                                        "items": {
                                                                            "type": [
                                                                                "object",
                                                                                "null"
                                                                            ],
                                                                            "description": "One field.",
                                                                            "properties": {
                                                                                "id": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "format": "uuid",
                                                                                    "description": "The id of the field."
                                                                                },
                                                                                "name": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "What the field is called, such as Serial number."
                                                                                },
                                                                                "kind": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "What the field holds: text, number, date, boolean, select, or rating from one to five."
                                                                                },
                                                                                "options": {
                                                                                    "type": [
                                                                                        "array",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "The choices of a select field, in order, or null for every other kind.",
                                                                                    "items": {
                                                                                        "type": [
                                                                                            "string",
                                                                                            "null"
                                                                                        ],
                                                                                        "description": "One choice."
                                                                                    }
                                                                                },
                                                                                "position": {
                                                                                    "type": [
                                                                                        "integer",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Its place among its siblings, counting from 1."
                                                                                },
                                                                                "group_id": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "format": "uuid",
                                                                                    "description": "The group it sits in, or null when it stands alone."
                                                                                }
                                                                            }
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "fields": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The fields standing outside any group, in order.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One field.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the field."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field is called, such as Serial number."
                                                                    },
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field holds: text, number, date, boolean, select, or rating from one to five."
                                                                    },
                                                                    "options": {
                                                                        "type": [
                                                                            "array",
                                                                            "null"
                                                                        ],
                                                                        "description": "The choices of a select field, in order, or null for every other kind.",
                                                                        "items": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "One choice."
                                                                        }
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Its place among its siblings, counting from 1."
                                                                    },
                                                                    "group_id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The group it sits in, or null when it stands alone."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the type was added, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When its name, colour or icon last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The screen where the possession type is edited in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_type",
                                        "id": "9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35",
                                        "attributes": {
                                            "name": "Office equipment",
                                            "colour": "#2f7f86",
                                            "icon": "briefcase",
                                            "field_count": 3,
                                            "groups": [
                                                {
                                                    "id": "4f2a8c61-7d93-4e05-b1c8-93a6d5e20b17",
                                                    "name": "Purchase",
                                                    "position": 1,
                                                    "fields": [
                                                        {
                                                            "id": "b7e04a93-1c6f-4d28-9a35-6f8e2d1c4b90",
                                                            "name": "Payment method",
                                                            "kind": "select",
                                                            "options": [
                                                                "Cash",
                                                                "Card"
                                                            ],
                                                            "position": 1,
                                                            "group_id": "4f2a8c61-7d93-4e05-b1c8-93a6d5e20b17"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "fields": [
                                                {
                                                    "id": "e5c37a28-9f14-4b6d-a083-7d2e1f9b6c45",
                                                    "name": "Condition",
                                                    "kind": "select",
                                                    "options": [
                                                        "New",
                                                        "Used",
                                                        "Broken"
                                                    ],
                                                    "position": 1,
                                                    "group_id": null
                                                },
                                                {
                                                    "id": "2d8b5f1e-6a47-4c93-8e02-1b9f7c3a5d64",
                                                    "name": "Serial number",
                                                    "kind": "text",
                                                    "options": null,
                                                    "position": 2,
                                                    "group_id": null
                                                }
                                            ],
                                            "created_at": 1761436800,
                                            "updated_at": 1761440400
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/possession-types/9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35",
                                            "web": "https://my.monicahq.com/settings/account/possession-types/9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35/edit"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "possession-types-show-query",
                "tags": [
                    "Possession types"
                ],
                "summary": "Get a possession type",
                "description": "Retrieve one possession type with its groups and fields.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "possessionType",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession type. A type belonging to somebody else answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A possession type object. A type belonging to somebody else answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession type.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the kind of thing is called: office equipment, a vehicle, a musical instrument."
                                                        },
                                                        "colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of the eight vault colours, as a hexadecimal value."
                                                        },
                                                        "icon": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of the glyphs of the catalogue (the same list sections and possession conditions use), or null. A type without one is drawn with a blank page."
                                                        },
                                                        "field_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many fields the type has, grouped or not."
                                                        },
                                                        "groups": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The groups of fields, in order.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One group.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the group."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the group is called, such as Purchase."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Its place among the groups, counting from 1."
                                                                    },
                                                                    "fields": {
                                                                        "type": [
                                                                            "array",
                                                                            "null"
                                                                        ],
                                                                        "description": "The fields of the group, in order.",
                                                                        "items": {
                                                                            "type": [
                                                                                "object",
                                                                                "null"
                                                                            ],
                                                                            "description": "One field.",
                                                                            "properties": {
                                                                                "id": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "format": "uuid",
                                                                                    "description": "The id of the field."
                                                                                },
                                                                                "name": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "What the field is called, such as Serial number."
                                                                                },
                                                                                "kind": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "What the field holds: text, number, date, boolean, select, or rating from one to five."
                                                                                },
                                                                                "options": {
                                                                                    "type": [
                                                                                        "array",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "The choices of a select field, in order, or null for every other kind.",
                                                                                    "items": {
                                                                                        "type": [
                                                                                            "string",
                                                                                            "null"
                                                                                        ],
                                                                                        "description": "One choice."
                                                                                    }
                                                                                },
                                                                                "position": {
                                                                                    "type": [
                                                                                        "integer",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Its place among its siblings, counting from 1."
                                                                                },
                                                                                "group_id": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "format": "uuid",
                                                                                    "description": "The group it sits in, or null when it stands alone."
                                                                                }
                                                                            }
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "fields": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The fields standing outside any group, in order.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One field.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the field."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field is called, such as Serial number."
                                                                    },
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field holds: text, number, date, boolean, select, or rating from one to five."
                                                                    },
                                                                    "options": {
                                                                        "type": [
                                                                            "array",
                                                                            "null"
                                                                        ],
                                                                        "description": "The choices of a select field, in order, or null for every other kind.",
                                                                        "items": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "One choice."
                                                                        }
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Its place among its siblings, counting from 1."
                                                                    },
                                                                    "group_id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The group it sits in, or null when it stands alone."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the type was added, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When its name, colour or icon last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The screen where the possession type is edited in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_type",
                                        "id": "9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35",
                                        "attributes": {
                                            "name": "Office equipment",
                                            "colour": "#2f7f86",
                                            "icon": "briefcase",
                                            "field_count": 3,
                                            "groups": [
                                                {
                                                    "id": "4f2a8c61-7d93-4e05-b1c8-93a6d5e20b17",
                                                    "name": "Purchase",
                                                    "position": 1,
                                                    "fields": [
                                                        {
                                                            "id": "b7e04a93-1c6f-4d28-9a35-6f8e2d1c4b90",
                                                            "name": "Payment method",
                                                            "kind": "select",
                                                            "options": [
                                                                "Cash",
                                                                "Card"
                                                            ],
                                                            "position": 1,
                                                            "group_id": "4f2a8c61-7d93-4e05-b1c8-93a6d5e20b17"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "fields": [
                                                {
                                                    "id": "e5c37a28-9f14-4b6d-a083-7d2e1f9b6c45",
                                                    "name": "Condition",
                                                    "kind": "select",
                                                    "options": [
                                                        "New",
                                                        "Used",
                                                        "Broken"
                                                    ],
                                                    "position": 1,
                                                    "group_id": null
                                                },
                                                {
                                                    "id": "2d8b5f1e-6a47-4c93-8e02-1b9f7c3a5d64",
                                                    "name": "Serial number",
                                                    "kind": "text",
                                                    "options": null,
                                                    "position": 2,
                                                    "group_id": null
                                                }
                                            ],
                                            "created_at": 1761436800,
                                            "updated_at": 1761440400
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/possession-types/9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35",
                                            "web": "https://my.monicahq.com/settings/account/possession-types/9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35/edit"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "put": {
                "operationId": "possession-types-update",
                "tags": [
                    "Possession types"
                ],
                "summary": "Change a possession type",
                "description": "Rename a possession type, or set its colour or its icon. The name and the colour cannot be null; an icon sent as null is removed.\n\nThe change is written to the account log.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "possessionType",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession type. A type belonging to somebody else answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "description": "The new name. Up to 255 characters. Markup and surrounding blank space are stripped, and a name left with nothing in it is refused."
                                    },
                                    "colour": {
                                        "type": "string",
                                        "description": "One of the vault colours, as a hexadecimal value. It cannot be null."
                                    },
                                    "icon": {
                                        "type": "string",
                                        "description": "One of the glyphs of the catalogue, or null for none. Anything else answers 422."
                                    }
                                }
                            },
                            "example": {
                                "name": "Office equipment",
                                "colour": "#2f7f86",
                                "icon": "briefcase"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The possession type object as it now reads.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession type.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the kind of thing is called: office equipment, a vehicle, a musical instrument."
                                                        },
                                                        "colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of the eight vault colours, as a hexadecimal value."
                                                        },
                                                        "icon": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of the glyphs of the catalogue (the same list sections and possession conditions use), or null. A type without one is drawn with a blank page."
                                                        },
                                                        "field_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many fields the type has, grouped or not."
                                                        },
                                                        "groups": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The groups of fields, in order.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One group.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the group."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the group is called, such as Purchase."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Its place among the groups, counting from 1."
                                                                    },
                                                                    "fields": {
                                                                        "type": [
                                                                            "array",
                                                                            "null"
                                                                        ],
                                                                        "description": "The fields of the group, in order.",
                                                                        "items": {
                                                                            "type": [
                                                                                "object",
                                                                                "null"
                                                                            ],
                                                                            "description": "One field.",
                                                                            "properties": {
                                                                                "id": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "format": "uuid",
                                                                                    "description": "The id of the field."
                                                                                },
                                                                                "name": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "What the field is called, such as Serial number."
                                                                                },
                                                                                "kind": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "What the field holds: text, number, date, boolean, select, or rating from one to five."
                                                                                },
                                                                                "options": {
                                                                                    "type": [
                                                                                        "array",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "The choices of a select field, in order, or null for every other kind.",
                                                                                    "items": {
                                                                                        "type": [
                                                                                            "string",
                                                                                            "null"
                                                                                        ],
                                                                                        "description": "One choice."
                                                                                    }
                                                                                },
                                                                                "position": {
                                                                                    "type": [
                                                                                        "integer",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Its place among its siblings, counting from 1."
                                                                                },
                                                                                "group_id": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "format": "uuid",
                                                                                    "description": "The group it sits in, or null when it stands alone."
                                                                                }
                                                                            }
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "fields": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The fields standing outside any group, in order.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One field.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the field."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field is called, such as Serial number."
                                                                    },
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field holds: text, number, date, boolean, select, or rating from one to five."
                                                                    },
                                                                    "options": {
                                                                        "type": [
                                                                            "array",
                                                                            "null"
                                                                        ],
                                                                        "description": "The choices of a select field, in order, or null for every other kind.",
                                                                        "items": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "One choice."
                                                                        }
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Its place among its siblings, counting from 1."
                                                                    },
                                                                    "group_id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The group it sits in, or null when it stands alone."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the type was added, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When its name, colour or icon last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The screen where the possession type is edited in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_type",
                                        "id": "9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35",
                                        "attributes": {
                                            "name": "Office equipment",
                                            "colour": "#2f7f86",
                                            "icon": "briefcase",
                                            "field_count": 3,
                                            "groups": [
                                                {
                                                    "id": "4f2a8c61-7d93-4e05-b1c8-93a6d5e20b17",
                                                    "name": "Purchase",
                                                    "position": 1,
                                                    "fields": [
                                                        {
                                                            "id": "b7e04a93-1c6f-4d28-9a35-6f8e2d1c4b90",
                                                            "name": "Payment method",
                                                            "kind": "select",
                                                            "options": [
                                                                "Cash",
                                                                "Card"
                                                            ],
                                                            "position": 1,
                                                            "group_id": "4f2a8c61-7d93-4e05-b1c8-93a6d5e20b17"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "fields": [
                                                {
                                                    "id": "e5c37a28-9f14-4b6d-a083-7d2e1f9b6c45",
                                                    "name": "Condition",
                                                    "kind": "select",
                                                    "options": [
                                                        "New",
                                                        "Used",
                                                        "Broken"
                                                    ],
                                                    "position": 1,
                                                    "group_id": null
                                                },
                                                {
                                                    "id": "2d8b5f1e-6a47-4c93-8e02-1b9f7c3a5d64",
                                                    "name": "Serial number",
                                                    "kind": "text",
                                                    "options": null,
                                                    "position": 2,
                                                    "group_id": null
                                                }
                                            ],
                                            "created_at": 1761436800,
                                            "updated_at": 1761440400
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/possession-types/9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35",
                                            "web": "https://my.monicahq.com/settings/account/possession-types/9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35/edit"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "delete": {
                "operationId": "possession-types-destroy",
                "tags": [
                    "Possession types"
                ],
                "summary": "Delete a possession type",
                "description": "Delete a possession type with its groups, its fields, and every possession of that type with the values it held.\n\nThe deletion is final. The account log keeps the name of the type and, when possessions went with it, how many.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "possessionType",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession type. A type belonging to somebody else answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Nothing. A type belonging to somebody else answers 404."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/possession-types/{possessionType}/export": {
            "get": {
                "operationId": "possession-types-export",
                "tags": [
                    "Possession types"
                ],
                "summary": "Export a possession type",
                "description": "Write a possession type out as a file you can import again, here or in another account.\n\nThe file holds the structure only: no thing you own and no value you wrote.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "possessionType",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession type. A type belonging to somebody else answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The file, as a JSON object. A type belonging to somebody else answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "format": {
                                            "type": [
                                                "string",
                                                "null"
                                            ],
                                            "description": "Always possession_type."
                                        },
                                        "format_version": {
                                            "type": [
                                                "integer",
                                                "null"
                                            ],
                                            "description": "The version of the format that wrote the file."
                                        },
                                        "possession_type": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The type itself.",
                                            "properties": {
                                                "name": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Its name."
                                                },
                                                "colour": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Its colour."
                                                },
                                                "icon": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Its icon, or null. A file without it imports with no icon; a glyph outside the catalogue is a problem."
                                                },
                                                "groups": {
                                                    "type": [
                                                        "array",
                                                        "null"
                                                    ],
                                                    "description": "Its groups, in order.",
                                                    "items": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "One group.",
                                                        "properties": {
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The name of the group."
                                                            },
                                                            "fields": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "The fields of the group, in order.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One field.",
                                                                    "properties": {
                                                                        "name": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The name of the field."
                                                                        },
                                                                        "kind": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "What the field holds."
                                                                        },
                                                                        "options": {
                                                                            "type": [
                                                                                "array",
                                                                                "null"
                                                                            ],
                                                                            "description": "The choices, present on a select field only.",
                                                                            "items": {
                                                                                "type": [
                                                                                    "string",
                                                                                    "null"
                                                                                ],
                                                                                "description": "One choice."
                                                                            }
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                },
                                                "fields": {
                                                    "type": [
                                                        "array",
                                                        "null"
                                                    ],
                                                    "description": "The fields standing outside any group, in order.",
                                                    "items": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "One field.",
                                                        "properties": {
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The name of the field."
                                                            },
                                                            "kind": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the field holds."
                                                            },
                                                            "options": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "The choices, present on a select field only.",
                                                                "items": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "One choice."
                                                                }
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "format": "possession_type",
                                    "format_version": 1,
                                    "possession_type": {
                                        "name": "Office equipment",
                                        "colour": "#2f7f86",
                                        "icon": "briefcase",
                                        "groups": [
                                            {
                                                "name": "Purchase",
                                                "fields": [
                                                    {
                                                        "name": "Payment method",
                                                        "kind": "select",
                                                        "options": [
                                                            "Cash",
                                                            "Card"
                                                        ]
                                                    }
                                                ]
                                            }
                                        ],
                                        "fields": [
                                            {
                                                "name": "Condition",
                                                "kind": "select",
                                                "options": [
                                                    "New",
                                                    "Used",
                                                    "Broken"
                                                ]
                                            },
                                            {
                                                "name": "Serial number",
                                                "kind": "text"
                                            }
                                        ]
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "possession-types-export-query",
                "tags": [
                    "Possession types"
                ],
                "summary": "Export a possession type",
                "description": "Write a possession type out as a file you can import again, here or in another account.\n\nThe file holds the structure only: no thing you own and no value you wrote.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "possessionType",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession type. A type belonging to somebody else answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The file, as a JSON object. A type belonging to somebody else answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "format": {
                                            "type": [
                                                "string",
                                                "null"
                                            ],
                                            "description": "Always possession_type."
                                        },
                                        "format_version": {
                                            "type": [
                                                "integer",
                                                "null"
                                            ],
                                            "description": "The version of the format that wrote the file."
                                        },
                                        "possession_type": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The type itself.",
                                            "properties": {
                                                "name": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Its name."
                                                },
                                                "colour": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Its colour."
                                                },
                                                "icon": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Its icon, or null. A file without it imports with no icon; a glyph outside the catalogue is a problem."
                                                },
                                                "groups": {
                                                    "type": [
                                                        "array",
                                                        "null"
                                                    ],
                                                    "description": "Its groups, in order.",
                                                    "items": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "One group.",
                                                        "properties": {
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The name of the group."
                                                            },
                                                            "fields": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "The fields of the group, in order.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One field.",
                                                                    "properties": {
                                                                        "name": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The name of the field."
                                                                        },
                                                                        "kind": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "What the field holds."
                                                                        },
                                                                        "options": {
                                                                            "type": [
                                                                                "array",
                                                                                "null"
                                                                            ],
                                                                            "description": "The choices, present on a select field only.",
                                                                            "items": {
                                                                                "type": [
                                                                                    "string",
                                                                                    "null"
                                                                                ],
                                                                                "description": "One choice."
                                                                            }
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                },
                                                "fields": {
                                                    "type": [
                                                        "array",
                                                        "null"
                                                    ],
                                                    "description": "The fields standing outside any group, in order.",
                                                    "items": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "One field.",
                                                        "properties": {
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The name of the field."
                                                            },
                                                            "kind": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the field holds."
                                                            },
                                                            "options": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "The choices, present on a select field only.",
                                                                "items": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "One choice."
                                                                }
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "format": "possession_type",
                                    "format_version": 1,
                                    "possession_type": {
                                        "name": "Office equipment",
                                        "colour": "#2f7f86",
                                        "icon": "briefcase",
                                        "groups": [
                                            {
                                                "name": "Purchase",
                                                "fields": [
                                                    {
                                                        "name": "Payment method",
                                                        "kind": "select",
                                                        "options": [
                                                            "Cash",
                                                            "Card"
                                                        ]
                                                    }
                                                ]
                                            }
                                        ],
                                        "fields": [
                                            {
                                                "name": "Condition",
                                                "kind": "select",
                                                "options": [
                                                    "New",
                                                    "Used",
                                                    "Broken"
                                                ]
                                            },
                                            {
                                                "name": "Serial number",
                                                "kind": "text"
                                            }
                                        ]
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/possession-types/import": {
            "post": {
                "operationId": "possession-types-import",
                "tags": [
                    "Possession types"
                ],
                "summary": "Import a possession type",
                "description": "Create a new possession type from a file written by the export. Nothing already in the account changes.\n\nA file with any problem creates nothing, and answers 422 on file with every problem listed, such as \"Group 1 needs a name.\" or \"The standalone fields, field 2 has an unknown kind.\"\n\nThe file may be at most 100 KB, with 50 groups, 300 fields and 200 choices per field. A file naming no colour takes #4a4a52.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "file": {
                                        "type": "string",
                                        "description": "The whole file, as JSON text."
                                    }
                                },
                                "required": [
                                    "file"
                                ]
                            },
                            "example": {
                                "file": "{\"format\":\"possession_type\",\"format_version\":1,\"possession_type\":{\"name\":\"Office equipment\",\"colour\":\"#2f7f86\",\"icon\":\"briefcase\",\"groups\":[{\"name\":\"Purchase\",\"fields\":[{\"name\":\"Payment method\",\"kind\":\"select\",\"options\":[\"Cash\",\"Card\"]}]}],\"fields\":[{\"name\":\"Condition\",\"kind\":\"select\",\"options\":[\"New\",\"Used\",\"Broken\"]},{\"name\":\"Serial number\",\"kind\":\"text\"}]}}"
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The possession type object that was created.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession type.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the kind of thing is called: office equipment, a vehicle, a musical instrument."
                                                        },
                                                        "colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of the eight vault colours, as a hexadecimal value."
                                                        },
                                                        "icon": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of the glyphs of the catalogue (the same list sections and possession conditions use), or null. A type without one is drawn with a blank page."
                                                        },
                                                        "field_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many fields the type has, grouped or not."
                                                        },
                                                        "groups": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The groups of fields, in order.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One group.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the group."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the group is called, such as Purchase."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Its place among the groups, counting from 1."
                                                                    },
                                                                    "fields": {
                                                                        "type": [
                                                                            "array",
                                                                            "null"
                                                                        ],
                                                                        "description": "The fields of the group, in order.",
                                                                        "items": {
                                                                            "type": [
                                                                                "object",
                                                                                "null"
                                                                            ],
                                                                            "description": "One field.",
                                                                            "properties": {
                                                                                "id": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "format": "uuid",
                                                                                    "description": "The id of the field."
                                                                                },
                                                                                "name": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "What the field is called, such as Serial number."
                                                                                },
                                                                                "kind": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "What the field holds: text, number, date, boolean, select, or rating from one to five."
                                                                                },
                                                                                "options": {
                                                                                    "type": [
                                                                                        "array",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "The choices of a select field, in order, or null for every other kind.",
                                                                                    "items": {
                                                                                        "type": [
                                                                                            "string",
                                                                                            "null"
                                                                                        ],
                                                                                        "description": "One choice."
                                                                                    }
                                                                                },
                                                                                "position": {
                                                                                    "type": [
                                                                                        "integer",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Its place among its siblings, counting from 1."
                                                                                },
                                                                                "group_id": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "format": "uuid",
                                                                                    "description": "The group it sits in, or null when it stands alone."
                                                                                }
                                                                            }
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "fields": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The fields standing outside any group, in order.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One field.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the field."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field is called, such as Serial number."
                                                                    },
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field holds: text, number, date, boolean, select, or rating from one to five."
                                                                    },
                                                                    "options": {
                                                                        "type": [
                                                                            "array",
                                                                            "null"
                                                                        ],
                                                                        "description": "The choices of a select field, in order, or null for every other kind.",
                                                                        "items": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "One choice."
                                                                        }
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Its place among its siblings, counting from 1."
                                                                    },
                                                                    "group_id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The group it sits in, or null when it stands alone."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the type was added, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When its name, colour or icon last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The screen where the possession type is edited in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_type",
                                        "id": "9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35",
                                        "attributes": {
                                            "name": "Office equipment",
                                            "colour": "#2f7f86",
                                            "icon": "briefcase",
                                            "field_count": 3,
                                            "groups": [
                                                {
                                                    "id": "4f2a8c61-7d93-4e05-b1c8-93a6d5e20b17",
                                                    "name": "Purchase",
                                                    "position": 1,
                                                    "fields": [
                                                        {
                                                            "id": "b7e04a93-1c6f-4d28-9a35-6f8e2d1c4b90",
                                                            "name": "Payment method",
                                                            "kind": "select",
                                                            "options": [
                                                                "Cash",
                                                                "Card"
                                                            ],
                                                            "position": 1,
                                                            "group_id": "4f2a8c61-7d93-4e05-b1c8-93a6d5e20b17"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "fields": [
                                                {
                                                    "id": "e5c37a28-9f14-4b6d-a083-7d2e1f9b6c45",
                                                    "name": "Condition",
                                                    "kind": "select",
                                                    "options": [
                                                        "New",
                                                        "Used",
                                                        "Broken"
                                                    ],
                                                    "position": 1,
                                                    "group_id": null
                                                },
                                                {
                                                    "id": "2d8b5f1e-6a47-4c93-8e02-1b9f7c3a5d64",
                                                    "name": "Serial number",
                                                    "kind": "text",
                                                    "options": null,
                                                    "position": 2,
                                                    "group_id": null
                                                }
                                            ],
                                            "created_at": 1761436800,
                                            "updated_at": 1761440400
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/possession-types/9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35",
                                            "web": "https://my.monicahq.com/settings/account/possession-types/9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35/edit"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/possession-types/{possessionType}/groups": {
            "post": {
                "operationId": "possession-field-groups-create",
                "tags": [
                    "Possession types"
                ],
                "summary": "Add a group of fields",
                "description": "Add a named group of fields to a possession type, placed after the other groups.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "possessionType",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession type. A type belonging to somebody else answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "description": "What the group is called. Up to 255 characters. Markup and surrounding blank space are stripped, and a name left with nothing in it is refused."
                                    }
                                },
                                "required": [
                                    "name"
                                ]
                            },
                            "example": {
                                "name": "Purchase"
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The possession type object, with the new group.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession type.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the kind of thing is called: office equipment, a vehicle, a musical instrument."
                                                        },
                                                        "colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of the eight vault colours, as a hexadecimal value."
                                                        },
                                                        "icon": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of the glyphs of the catalogue (the same list sections and possession conditions use), or null. A type without one is drawn with a blank page."
                                                        },
                                                        "field_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many fields the type has, grouped or not."
                                                        },
                                                        "groups": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The groups of fields, in order.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One group.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the group."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the group is called, such as Purchase."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Its place among the groups, counting from 1."
                                                                    },
                                                                    "fields": {
                                                                        "type": [
                                                                            "array",
                                                                            "null"
                                                                        ],
                                                                        "description": "The fields of the group, in order.",
                                                                        "items": {
                                                                            "type": [
                                                                                "object",
                                                                                "null"
                                                                            ],
                                                                            "description": "One field.",
                                                                            "properties": {
                                                                                "id": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "format": "uuid",
                                                                                    "description": "The id of the field."
                                                                                },
                                                                                "name": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "What the field is called, such as Serial number."
                                                                                },
                                                                                "kind": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "What the field holds: text, number, date, boolean, select, or rating from one to five."
                                                                                },
                                                                                "options": {
                                                                                    "type": [
                                                                                        "array",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "The choices of a select field, in order, or null for every other kind.",
                                                                                    "items": {
                                                                                        "type": [
                                                                                            "string",
                                                                                            "null"
                                                                                        ],
                                                                                        "description": "One choice."
                                                                                    }
                                                                                },
                                                                                "position": {
                                                                                    "type": [
                                                                                        "integer",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Its place among its siblings, counting from 1."
                                                                                },
                                                                                "group_id": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "format": "uuid",
                                                                                    "description": "The group it sits in, or null when it stands alone."
                                                                                }
                                                                            }
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "fields": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The fields standing outside any group, in order.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One field.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the field."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field is called, such as Serial number."
                                                                    },
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field holds: text, number, date, boolean, select, or rating from one to five."
                                                                    },
                                                                    "options": {
                                                                        "type": [
                                                                            "array",
                                                                            "null"
                                                                        ],
                                                                        "description": "The choices of a select field, in order, or null for every other kind.",
                                                                        "items": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "One choice."
                                                                        }
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Its place among its siblings, counting from 1."
                                                                    },
                                                                    "group_id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The group it sits in, or null when it stands alone."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the type was added, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When its name, colour or icon last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The screen where the possession type is edited in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_type",
                                        "id": "9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35",
                                        "attributes": {
                                            "name": "Office equipment",
                                            "colour": "#2f7f86",
                                            "icon": "briefcase",
                                            "field_count": 3,
                                            "groups": [
                                                {
                                                    "id": "4f2a8c61-7d93-4e05-b1c8-93a6d5e20b17",
                                                    "name": "Purchase",
                                                    "position": 1,
                                                    "fields": [
                                                        {
                                                            "id": "b7e04a93-1c6f-4d28-9a35-6f8e2d1c4b90",
                                                            "name": "Payment method",
                                                            "kind": "select",
                                                            "options": [
                                                                "Cash",
                                                                "Card"
                                                            ],
                                                            "position": 1,
                                                            "group_id": "4f2a8c61-7d93-4e05-b1c8-93a6d5e20b17"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "fields": [
                                                {
                                                    "id": "e5c37a28-9f14-4b6d-a083-7d2e1f9b6c45",
                                                    "name": "Condition",
                                                    "kind": "select",
                                                    "options": [
                                                        "New",
                                                        "Used",
                                                        "Broken"
                                                    ],
                                                    "position": 1,
                                                    "group_id": null
                                                },
                                                {
                                                    "id": "2d8b5f1e-6a47-4c93-8e02-1b9f7c3a5d64",
                                                    "name": "Serial number",
                                                    "kind": "text",
                                                    "options": null,
                                                    "position": 2,
                                                    "group_id": null
                                                }
                                            ],
                                            "created_at": 1761436800,
                                            "updated_at": 1761440400
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/possession-types/9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35",
                                            "web": "https://my.monicahq.com/settings/account/possession-types/9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35/edit"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/possession-types/{possessionType}/groups/{group}": {
            "put": {
                "operationId": "possession-field-groups-update",
                "tags": [
                    "Possession types"
                ],
                "summary": "Rename a group of fields",
                "description": "Rename a group of fields.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "possessionType",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession type. A type belonging to somebody else answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "group",
                        "in": "path",
                        "required": true,
                        "description": "The id of the group. A group of another type answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "description": "The new name. Up to 255 characters. Markup and surrounding blank space are stripped, and a name left with nothing in it is refused."
                                    }
                                }
                            },
                            "example": {
                                "name": "Purchase"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The possession type object as it now reads.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession type.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the kind of thing is called: office equipment, a vehicle, a musical instrument."
                                                        },
                                                        "colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of the eight vault colours, as a hexadecimal value."
                                                        },
                                                        "icon": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of the glyphs of the catalogue (the same list sections and possession conditions use), or null. A type without one is drawn with a blank page."
                                                        },
                                                        "field_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many fields the type has, grouped or not."
                                                        },
                                                        "groups": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The groups of fields, in order.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One group.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the group."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the group is called, such as Purchase."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Its place among the groups, counting from 1."
                                                                    },
                                                                    "fields": {
                                                                        "type": [
                                                                            "array",
                                                                            "null"
                                                                        ],
                                                                        "description": "The fields of the group, in order.",
                                                                        "items": {
                                                                            "type": [
                                                                                "object",
                                                                                "null"
                                                                            ],
                                                                            "description": "One field.",
                                                                            "properties": {
                                                                                "id": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "format": "uuid",
                                                                                    "description": "The id of the field."
                                                                                },
                                                                                "name": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "What the field is called, such as Serial number."
                                                                                },
                                                                                "kind": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "What the field holds: text, number, date, boolean, select, or rating from one to five."
                                                                                },
                                                                                "options": {
                                                                                    "type": [
                                                                                        "array",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "The choices of a select field, in order, or null for every other kind.",
                                                                                    "items": {
                                                                                        "type": [
                                                                                            "string",
                                                                                            "null"
                                                                                        ],
                                                                                        "description": "One choice."
                                                                                    }
                                                                                },
                                                                                "position": {
                                                                                    "type": [
                                                                                        "integer",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Its place among its siblings, counting from 1."
                                                                                },
                                                                                "group_id": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "format": "uuid",
                                                                                    "description": "The group it sits in, or null when it stands alone."
                                                                                }
                                                                            }
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "fields": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The fields standing outside any group, in order.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One field.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the field."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field is called, such as Serial number."
                                                                    },
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field holds: text, number, date, boolean, select, or rating from one to five."
                                                                    },
                                                                    "options": {
                                                                        "type": [
                                                                            "array",
                                                                            "null"
                                                                        ],
                                                                        "description": "The choices of a select field, in order, or null for every other kind.",
                                                                        "items": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "One choice."
                                                                        }
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Its place among its siblings, counting from 1."
                                                                    },
                                                                    "group_id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The group it sits in, or null when it stands alone."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the type was added, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When its name, colour or icon last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The screen where the possession type is edited in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_type",
                                        "id": "9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35",
                                        "attributes": {
                                            "name": "Office equipment",
                                            "colour": "#2f7f86",
                                            "icon": "briefcase",
                                            "field_count": 3,
                                            "groups": [
                                                {
                                                    "id": "4f2a8c61-7d93-4e05-b1c8-93a6d5e20b17",
                                                    "name": "Purchase",
                                                    "position": 1,
                                                    "fields": [
                                                        {
                                                            "id": "b7e04a93-1c6f-4d28-9a35-6f8e2d1c4b90",
                                                            "name": "Payment method",
                                                            "kind": "select",
                                                            "options": [
                                                                "Cash",
                                                                "Card"
                                                            ],
                                                            "position": 1,
                                                            "group_id": "4f2a8c61-7d93-4e05-b1c8-93a6d5e20b17"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "fields": [
                                                {
                                                    "id": "e5c37a28-9f14-4b6d-a083-7d2e1f9b6c45",
                                                    "name": "Condition",
                                                    "kind": "select",
                                                    "options": [
                                                        "New",
                                                        "Used",
                                                        "Broken"
                                                    ],
                                                    "position": 1,
                                                    "group_id": null
                                                },
                                                {
                                                    "id": "2d8b5f1e-6a47-4c93-8e02-1b9f7c3a5d64",
                                                    "name": "Serial number",
                                                    "kind": "text",
                                                    "options": null,
                                                    "position": 2,
                                                    "group_id": null
                                                }
                                            ],
                                            "created_at": 1761436800,
                                            "updated_at": 1761440400
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/possession-types/9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35",
                                            "web": "https://my.monicahq.com/settings/account/possession-types/9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35/edit"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "delete": {
                "operationId": "possession-field-groups-destroy",
                "tags": [
                    "Possession types"
                ],
                "summary": "Remove a group of fields",
                "description": "Remove a group and keep its fields: they become standalone fields of the type, after the ones already there.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "possessionType",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession type. A type belonging to somebody else answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "group",
                        "in": "path",
                        "required": true,
                        "description": "The id of the group. A group of another type answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Nothing."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/possession-types/{possessionType}/groups/{group}/position": {
            "put": {
                "operationId": "possession-field-groups-position",
                "tags": [
                    "Possession types"
                ],
                "summary": "Move a group of fields",
                "description": "Move a group to another place among the groups of its type. Every group is numbered again from 1.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "possessionType",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession type. A type belonging to somebody else answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "group",
                        "in": "path",
                        "required": true,
                        "description": "The id of the group. A group of another type answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "position": {
                                        "type": "integer",
                                        "description": "Where it goes, counting from 1. A number past the end puts it last."
                                    }
                                },
                                "required": [
                                    "position"
                                ]
                            },
                            "example": {
                                "position": 1
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The possession type object as it now reads.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession type.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the kind of thing is called: office equipment, a vehicle, a musical instrument."
                                                        },
                                                        "colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of the eight vault colours, as a hexadecimal value."
                                                        },
                                                        "icon": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of the glyphs of the catalogue (the same list sections and possession conditions use), or null. A type without one is drawn with a blank page."
                                                        },
                                                        "field_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many fields the type has, grouped or not."
                                                        },
                                                        "groups": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The groups of fields, in order.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One group.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the group."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the group is called, such as Purchase."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Its place among the groups, counting from 1."
                                                                    },
                                                                    "fields": {
                                                                        "type": [
                                                                            "array",
                                                                            "null"
                                                                        ],
                                                                        "description": "The fields of the group, in order.",
                                                                        "items": {
                                                                            "type": [
                                                                                "object",
                                                                                "null"
                                                                            ],
                                                                            "description": "One field.",
                                                                            "properties": {
                                                                                "id": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "format": "uuid",
                                                                                    "description": "The id of the field."
                                                                                },
                                                                                "name": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "What the field is called, such as Serial number."
                                                                                },
                                                                                "kind": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "What the field holds: text, number, date, boolean, select, or rating from one to five."
                                                                                },
                                                                                "options": {
                                                                                    "type": [
                                                                                        "array",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "The choices of a select field, in order, or null for every other kind.",
                                                                                    "items": {
                                                                                        "type": [
                                                                                            "string",
                                                                                            "null"
                                                                                        ],
                                                                                        "description": "One choice."
                                                                                    }
                                                                                },
                                                                                "position": {
                                                                                    "type": [
                                                                                        "integer",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Its place among its siblings, counting from 1."
                                                                                },
                                                                                "group_id": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "format": "uuid",
                                                                                    "description": "The group it sits in, or null when it stands alone."
                                                                                }
                                                                            }
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "fields": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The fields standing outside any group, in order.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One field.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the field."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field is called, such as Serial number."
                                                                    },
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field holds: text, number, date, boolean, select, or rating from one to five."
                                                                    },
                                                                    "options": {
                                                                        "type": [
                                                                            "array",
                                                                            "null"
                                                                        ],
                                                                        "description": "The choices of a select field, in order, or null for every other kind.",
                                                                        "items": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "One choice."
                                                                        }
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Its place among its siblings, counting from 1."
                                                                    },
                                                                    "group_id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The group it sits in, or null when it stands alone."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the type was added, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When its name, colour or icon last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The screen where the possession type is edited in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_type",
                                        "id": "9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35",
                                        "attributes": {
                                            "name": "Office equipment",
                                            "colour": "#2f7f86",
                                            "icon": "briefcase",
                                            "field_count": 3,
                                            "groups": [
                                                {
                                                    "id": "4f2a8c61-7d93-4e05-b1c8-93a6d5e20b17",
                                                    "name": "Purchase",
                                                    "position": 1,
                                                    "fields": [
                                                        {
                                                            "id": "b7e04a93-1c6f-4d28-9a35-6f8e2d1c4b90",
                                                            "name": "Payment method",
                                                            "kind": "select",
                                                            "options": [
                                                                "Cash",
                                                                "Card"
                                                            ],
                                                            "position": 1,
                                                            "group_id": "4f2a8c61-7d93-4e05-b1c8-93a6d5e20b17"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "fields": [
                                                {
                                                    "id": "e5c37a28-9f14-4b6d-a083-7d2e1f9b6c45",
                                                    "name": "Condition",
                                                    "kind": "select",
                                                    "options": [
                                                        "New",
                                                        "Used",
                                                        "Broken"
                                                    ],
                                                    "position": 1,
                                                    "group_id": null
                                                },
                                                {
                                                    "id": "2d8b5f1e-6a47-4c93-8e02-1b9f7c3a5d64",
                                                    "name": "Serial number",
                                                    "kind": "text",
                                                    "options": null,
                                                    "position": 2,
                                                    "group_id": null
                                                }
                                            ],
                                            "created_at": 1761436800,
                                            "updated_at": 1761440400
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/possession-types/9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35",
                                            "web": "https://my.monicahq.com/settings/account/possession-types/9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35/edit"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/possession-types/{possessionType}/fields": {
            "post": {
                "operationId": "possession-fields-create",
                "tags": [
                    "Possession types"
                ],
                "summary": "Add a field",
                "description": "Add a field to a possession type, in one of its groups or standing alone, placed last.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "possessionType",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession type. A type belonging to somebody else answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "description": "What the field is called. Up to 255 characters. Markup and surrounding blank space are stripped, and a name left with nothing in it is refused."
                                    },
                                    "kind": {
                                        "type": "string",
                                        "description": "One of text, number, date, boolean, select or rating."
                                    },
                                    "options": {
                                        "type": "array",
                                        "description": "The choices of a select field, in order, at most 200 of up to 255 characters each. Blank ones are dropped and a repeated one is refused. Ignored for every other kind."
                                    },
                                    "group_id": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "The group it goes in. Left out, the field stands alone. A group of another type is refused. The group cannot be changed later."
                                    }
                                },
                                "required": [
                                    "name",
                                    "kind"
                                ]
                            },
                            "example": {
                                "name": "Condition",
                                "kind": "select",
                                "options": [
                                    "New",
                                    "Used",
                                    "Broken"
                                ]
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The possession type object, with the new field.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession type.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the kind of thing is called: office equipment, a vehicle, a musical instrument."
                                                        },
                                                        "colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of the eight vault colours, as a hexadecimal value."
                                                        },
                                                        "icon": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of the glyphs of the catalogue (the same list sections and possession conditions use), or null. A type without one is drawn with a blank page."
                                                        },
                                                        "field_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many fields the type has, grouped or not."
                                                        },
                                                        "groups": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The groups of fields, in order.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One group.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the group."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the group is called, such as Purchase."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Its place among the groups, counting from 1."
                                                                    },
                                                                    "fields": {
                                                                        "type": [
                                                                            "array",
                                                                            "null"
                                                                        ],
                                                                        "description": "The fields of the group, in order.",
                                                                        "items": {
                                                                            "type": [
                                                                                "object",
                                                                                "null"
                                                                            ],
                                                                            "description": "One field.",
                                                                            "properties": {
                                                                                "id": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "format": "uuid",
                                                                                    "description": "The id of the field."
                                                                                },
                                                                                "name": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "What the field is called, such as Serial number."
                                                                                },
                                                                                "kind": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "What the field holds: text, number, date, boolean, select, or rating from one to five."
                                                                                },
                                                                                "options": {
                                                                                    "type": [
                                                                                        "array",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "The choices of a select field, in order, or null for every other kind.",
                                                                                    "items": {
                                                                                        "type": [
                                                                                            "string",
                                                                                            "null"
                                                                                        ],
                                                                                        "description": "One choice."
                                                                                    }
                                                                                },
                                                                                "position": {
                                                                                    "type": [
                                                                                        "integer",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Its place among its siblings, counting from 1."
                                                                                },
                                                                                "group_id": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "format": "uuid",
                                                                                    "description": "The group it sits in, or null when it stands alone."
                                                                                }
                                                                            }
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "fields": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The fields standing outside any group, in order.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One field.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the field."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field is called, such as Serial number."
                                                                    },
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field holds: text, number, date, boolean, select, or rating from one to five."
                                                                    },
                                                                    "options": {
                                                                        "type": [
                                                                            "array",
                                                                            "null"
                                                                        ],
                                                                        "description": "The choices of a select field, in order, or null for every other kind.",
                                                                        "items": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "One choice."
                                                                        }
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Its place among its siblings, counting from 1."
                                                                    },
                                                                    "group_id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The group it sits in, or null when it stands alone."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the type was added, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When its name, colour or icon last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The screen where the possession type is edited in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_type",
                                        "id": "9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35",
                                        "attributes": {
                                            "name": "Office equipment",
                                            "colour": "#2f7f86",
                                            "icon": "briefcase",
                                            "field_count": 3,
                                            "groups": [
                                                {
                                                    "id": "4f2a8c61-7d93-4e05-b1c8-93a6d5e20b17",
                                                    "name": "Purchase",
                                                    "position": 1,
                                                    "fields": [
                                                        {
                                                            "id": "b7e04a93-1c6f-4d28-9a35-6f8e2d1c4b90",
                                                            "name": "Payment method",
                                                            "kind": "select",
                                                            "options": [
                                                                "Cash",
                                                                "Card"
                                                            ],
                                                            "position": 1,
                                                            "group_id": "4f2a8c61-7d93-4e05-b1c8-93a6d5e20b17"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "fields": [
                                                {
                                                    "id": "e5c37a28-9f14-4b6d-a083-7d2e1f9b6c45",
                                                    "name": "Condition",
                                                    "kind": "select",
                                                    "options": [
                                                        "New",
                                                        "Used",
                                                        "Broken"
                                                    ],
                                                    "position": 1,
                                                    "group_id": null
                                                },
                                                {
                                                    "id": "2d8b5f1e-6a47-4c93-8e02-1b9f7c3a5d64",
                                                    "name": "Serial number",
                                                    "kind": "text",
                                                    "options": null,
                                                    "position": 2,
                                                    "group_id": null
                                                }
                                            ],
                                            "created_at": 1761436800,
                                            "updated_at": 1761440400
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/possession-types/9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35",
                                            "web": "https://my.monicahq.com/settings/account/possession-types/9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35/edit"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/possession-types/{possessionType}/fields/{field}": {
            "put": {
                "operationId": "possession-fields-update",
                "tags": [
                    "Possession types"
                ],
                "summary": "Change a field",
                "description": "Rename a field, change its kind and set its choices.\n\nSend only what changes. The name and the kind cannot be null. Options left out keep the choices the field has, and options sent as null or empty clear them. A field that stops being a select field loses its choices. A choice removed from a select field is also removed from every possession that held it, and those possessions then hold no value for the field. The deletion is final.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "possessionType",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession type. A type belonging to somebody else answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "field",
                        "in": "path",
                        "required": true,
                        "description": "The id of the field. A field of another type answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "description": "What the field is called. Up to 255 characters. Markup and surrounding blank space are stripped, and a name left with nothing in it is refused."
                                    },
                                    "kind": {
                                        "type": "string",
                                        "description": "One of text, number, date, boolean, select or rating."
                                    },
                                    "options": {
                                        "type": "array",
                                        "description": "The choices of a select field, in order, at most 200 of up to 255 characters each. Blank ones are dropped and a repeated one is refused. Ignored for every other kind."
                                    }
                                }
                            },
                            "example": {
                                "name": "Condition",
                                "kind": "select",
                                "options": [
                                    "New",
                                    "Used",
                                    "Broken"
                                ]
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The possession type object as it now reads.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession type.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the kind of thing is called: office equipment, a vehicle, a musical instrument."
                                                        },
                                                        "colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of the eight vault colours, as a hexadecimal value."
                                                        },
                                                        "icon": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of the glyphs of the catalogue (the same list sections and possession conditions use), or null. A type without one is drawn with a blank page."
                                                        },
                                                        "field_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many fields the type has, grouped or not."
                                                        },
                                                        "groups": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The groups of fields, in order.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One group.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the group."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the group is called, such as Purchase."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Its place among the groups, counting from 1."
                                                                    },
                                                                    "fields": {
                                                                        "type": [
                                                                            "array",
                                                                            "null"
                                                                        ],
                                                                        "description": "The fields of the group, in order.",
                                                                        "items": {
                                                                            "type": [
                                                                                "object",
                                                                                "null"
                                                                            ],
                                                                            "description": "One field.",
                                                                            "properties": {
                                                                                "id": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "format": "uuid",
                                                                                    "description": "The id of the field."
                                                                                },
                                                                                "name": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "What the field is called, such as Serial number."
                                                                                },
                                                                                "kind": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "What the field holds: text, number, date, boolean, select, or rating from one to five."
                                                                                },
                                                                                "options": {
                                                                                    "type": [
                                                                                        "array",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "The choices of a select field, in order, or null for every other kind.",
                                                                                    "items": {
                                                                                        "type": [
                                                                                            "string",
                                                                                            "null"
                                                                                        ],
                                                                                        "description": "One choice."
                                                                                    }
                                                                                },
                                                                                "position": {
                                                                                    "type": [
                                                                                        "integer",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Its place among its siblings, counting from 1."
                                                                                },
                                                                                "group_id": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "format": "uuid",
                                                                                    "description": "The group it sits in, or null when it stands alone."
                                                                                }
                                                                            }
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "fields": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The fields standing outside any group, in order.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One field.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the field."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field is called, such as Serial number."
                                                                    },
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field holds: text, number, date, boolean, select, or rating from one to five."
                                                                    },
                                                                    "options": {
                                                                        "type": [
                                                                            "array",
                                                                            "null"
                                                                        ],
                                                                        "description": "The choices of a select field, in order, or null for every other kind.",
                                                                        "items": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "One choice."
                                                                        }
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Its place among its siblings, counting from 1."
                                                                    },
                                                                    "group_id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The group it sits in, or null when it stands alone."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the type was added, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When its name, colour or icon last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The screen where the possession type is edited in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_type",
                                        "id": "9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35",
                                        "attributes": {
                                            "name": "Office equipment",
                                            "colour": "#2f7f86",
                                            "icon": "briefcase",
                                            "field_count": 3,
                                            "groups": [
                                                {
                                                    "id": "4f2a8c61-7d93-4e05-b1c8-93a6d5e20b17",
                                                    "name": "Purchase",
                                                    "position": 1,
                                                    "fields": [
                                                        {
                                                            "id": "b7e04a93-1c6f-4d28-9a35-6f8e2d1c4b90",
                                                            "name": "Payment method",
                                                            "kind": "select",
                                                            "options": [
                                                                "Cash",
                                                                "Card"
                                                            ],
                                                            "position": 1,
                                                            "group_id": "4f2a8c61-7d93-4e05-b1c8-93a6d5e20b17"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "fields": [
                                                {
                                                    "id": "e5c37a28-9f14-4b6d-a083-7d2e1f9b6c45",
                                                    "name": "Condition",
                                                    "kind": "select",
                                                    "options": [
                                                        "New",
                                                        "Used",
                                                        "Broken"
                                                    ],
                                                    "position": 1,
                                                    "group_id": null
                                                },
                                                {
                                                    "id": "2d8b5f1e-6a47-4c93-8e02-1b9f7c3a5d64",
                                                    "name": "Serial number",
                                                    "kind": "text",
                                                    "options": null,
                                                    "position": 2,
                                                    "group_id": null
                                                }
                                            ],
                                            "created_at": 1761436800,
                                            "updated_at": 1761440400
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/possession-types/9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35",
                                            "web": "https://my.monicahq.com/settings/account/possession-types/9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35/edit"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "delete": {
                "operationId": "possession-fields-destroy",
                "tags": [
                    "Possession types"
                ],
                "summary": "Remove a field",
                "description": "Remove a field from its possession type.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "possessionType",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession type. A type belonging to somebody else answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "field",
                        "in": "path",
                        "required": true,
                        "description": "The id of the field. A field of another type answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Nothing."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/possession-types/{possessionType}/fields/{field}/position": {
            "put": {
                "operationId": "possession-fields-position",
                "tags": [
                    "Possession types"
                ],
                "summary": "Move a field",
                "description": "Move a field to another place among its siblings: the fields of its group, or the standalone fields of the type.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "possessionType",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession type. A type belonging to somebody else answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "field",
                        "in": "path",
                        "required": true,
                        "description": "The id of the field. A field of another type answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "position": {
                                        "type": "integer",
                                        "description": "Where it goes, counting from 1. A number past the end puts it last."
                                    }
                                },
                                "required": [
                                    "position"
                                ]
                            },
                            "example": {
                                "position": 1
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The possession type object as it now reads.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession type.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the kind of thing is called: office equipment, a vehicle, a musical instrument."
                                                        },
                                                        "colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of the eight vault colours, as a hexadecimal value."
                                                        },
                                                        "icon": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of the glyphs of the catalogue (the same list sections and possession conditions use), or null. A type without one is drawn with a blank page."
                                                        },
                                                        "field_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many fields the type has, grouped or not."
                                                        },
                                                        "groups": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The groups of fields, in order.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One group.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the group."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the group is called, such as Purchase."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Its place among the groups, counting from 1."
                                                                    },
                                                                    "fields": {
                                                                        "type": [
                                                                            "array",
                                                                            "null"
                                                                        ],
                                                                        "description": "The fields of the group, in order.",
                                                                        "items": {
                                                                            "type": [
                                                                                "object",
                                                                                "null"
                                                                            ],
                                                                            "description": "One field.",
                                                                            "properties": {
                                                                                "id": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "format": "uuid",
                                                                                    "description": "The id of the field."
                                                                                },
                                                                                "name": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "What the field is called, such as Serial number."
                                                                                },
                                                                                "kind": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "What the field holds: text, number, date, boolean, select, or rating from one to five."
                                                                                },
                                                                                "options": {
                                                                                    "type": [
                                                                                        "array",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "The choices of a select field, in order, or null for every other kind.",
                                                                                    "items": {
                                                                                        "type": [
                                                                                            "string",
                                                                                            "null"
                                                                                        ],
                                                                                        "description": "One choice."
                                                                                    }
                                                                                },
                                                                                "position": {
                                                                                    "type": [
                                                                                        "integer",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "Its place among its siblings, counting from 1."
                                                                                },
                                                                                "group_id": {
                                                                                    "type": [
                                                                                        "string",
                                                                                        "null"
                                                                                    ],
                                                                                    "format": "uuid",
                                                                                    "description": "The group it sits in, or null when it stands alone."
                                                                                }
                                                                            }
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "fields": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The fields standing outside any group, in order.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One field.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the field."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field is called, such as Serial number."
                                                                    },
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field holds: text, number, date, boolean, select, or rating from one to five."
                                                                    },
                                                                    "options": {
                                                                        "type": [
                                                                            "array",
                                                                            "null"
                                                                        ],
                                                                        "description": "The choices of a select field, in order, or null for every other kind.",
                                                                        "items": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "One choice."
                                                                        }
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Its place among its siblings, counting from 1."
                                                                    },
                                                                    "group_id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The group it sits in, or null when it stands alone."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the type was added, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When its name, colour or icon last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The screen where the possession type is edited in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_type",
                                        "id": "9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35",
                                        "attributes": {
                                            "name": "Office equipment",
                                            "colour": "#2f7f86",
                                            "icon": "briefcase",
                                            "field_count": 3,
                                            "groups": [
                                                {
                                                    "id": "4f2a8c61-7d93-4e05-b1c8-93a6d5e20b17",
                                                    "name": "Purchase",
                                                    "position": 1,
                                                    "fields": [
                                                        {
                                                            "id": "b7e04a93-1c6f-4d28-9a35-6f8e2d1c4b90",
                                                            "name": "Payment method",
                                                            "kind": "select",
                                                            "options": [
                                                                "Cash",
                                                                "Card"
                                                            ],
                                                            "position": 1,
                                                            "group_id": "4f2a8c61-7d93-4e05-b1c8-93a6d5e20b17"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "fields": [
                                                {
                                                    "id": "e5c37a28-9f14-4b6d-a083-7d2e1f9b6c45",
                                                    "name": "Condition",
                                                    "kind": "select",
                                                    "options": [
                                                        "New",
                                                        "Used",
                                                        "Broken"
                                                    ],
                                                    "position": 1,
                                                    "group_id": null
                                                },
                                                {
                                                    "id": "2d8b5f1e-6a47-4c93-8e02-1b9f7c3a5d64",
                                                    "name": "Serial number",
                                                    "kind": "text",
                                                    "options": null,
                                                    "position": 2,
                                                    "group_id": null
                                                }
                                            ],
                                            "created_at": 1761436800,
                                            "updated_at": 1761440400
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/possession-types/9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35",
                                            "web": "https://my.monicahq.com/settings/account/possession-types/9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35/edit"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/possessions": {
            "get": {
                "operationId": "possessions-index",
                "tags": [
                    "Possessions"
                ],
                "summary": "List possessions",
                "description": "List the possessions of a vault, sorted by name, each with its type, its location and its values.\n\nA possession belongs to a vault. Its type and its location belong to the account, so the same type and the same location serve every vault.\n\nSorted by position, the featured possessions come first in their order, followed by every other possession sorted by name.\n\nTo go through everything a vault holds, ask for compact possessions with the largest page.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "type",
                        "in": "query",
                        "required": false,
                        "description": "Only the possessions of this possession type.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "status",
                        "in": "query",
                        "required": false,
                        "description": "Only the possessions with this status: owned, ordered, sold, given_away, lost, stolen or thrown_away.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "featured",
                        "in": "query",
                        "required": false,
                        "description": "Only the featured possessions when true, only the others when false.",
                        "schema": {
                            "type": "boolean"
                        }
                    },
                    {
                        "name": "location",
                        "in": "query",
                        "required": false,
                        "description": "Only the possessions kept at this location or at any location inside it. A location that is not one of the account answers 422.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "sort",
                        "in": "query",
                        "required": false,
                        "description": "Either name or position.",
                        "schema": {
                            "type": "string",
                            "default": "name"
                        }
                    },
                    {
                        "name": "compact",
                        "in": "query",
                        "required": false,
                        "description": "When true, each possession carries only its name, its status, the id and name of its type, its location and its current value, which is about a tenth of the full record. Get one possession for the rest.",
                        "schema": {
                            "type": "boolean",
                            "default": false
                        }
                    },
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to answer with.",
                        "schema": {
                            "type": "integer",
                            "default": 1
                        }
                    },
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "How many possessions one page holds, between 1 and 100. A number outside the range is brought back into it.",
                        "schema": {
                            "type": "integer",
                            "default": 25
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of possession objects, and how many there are in all. A vault with none answers an empty list, and a vault of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The possessions on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One possession.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always possession. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the thing is called, such as World’s Best Boss mug."
                                                            },
                                                            "description": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Free text about the thing, or null."
                                                            },
                                                            "identifier": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "A serial number, a licence plate or any other reference written on the thing, or null."
                                                            },
                                                            "status": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Where the thing stands: owned, ordered, sold, given_away, lost, stolen or thrown_away."
                                                            },
                                                            "quantity": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How many of the thing there are, at least 1."
                                                            },
                                                            "is_featured": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the thing is featured, which places it in the order shown first in the vault."
                                                            },
                                                            "position": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "Its place among the featured possessions of the vault, counting from 1, or null when it is not featured."
                                                            },
                                                            "possession_type": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The kind of thing it is. It is chosen when the possession is added and never changes.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the possession type."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the type is called."
                                                                    },
                                                                    "colour": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The colour of the type, as a hexadecimal value."
                                                                    },
                                                                    "icon": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The icon of the type, one of the glyphs of the catalogue, or null."
                                                                    }
                                                                }
                                                            },
                                                            "location": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "Where the thing is kept now, or null when nobody said.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the location."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the location is called."
                                                                    }
                                                                }
                                                            },
                                                            "values": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "What the thing holds for the fields of its type, in the order of the fields: the groups first, then the standalone fields. A field holding nothing is left out.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One value.",
                                                                    "properties": {
                                                                        "field_id": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "format": "uuid",
                                                                            "description": "The id of the field, which is the key to send when writing its value."
                                                                        },
                                                                        "name": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "What the field is called."
                                                                        },
                                                                        "kind": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "What the field holds: text, number, date, boolean, select or rating."
                                                                        },
                                                                        "group": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The name of the group the field sits in, or null when it stands alone."
                                                                        },
                                                                        "value": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The value, as the kind of the field reads it: a string for text, a date written as 2005-03-24 and a choice, a number for a number, an integer from 1 to 5 for a rating, and true or false for a boolean."
                                                                        }
                                                                    }
                                                                }
                                                            },
                                                            "acquisition": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "How the thing was acquired, read from its acquisition transaction: the earliest purchase, exchange, gift received or inheritance. Each part is null without one. Change it through the transactions, since none of it can be written here.",
                                                                "properties": {
                                                                    "way": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The type of the acquisition transaction: purchase, exchange, gift_received or inheritance, or null."
                                                                    },
                                                                    "acquired_from": {
                                                                        "type": [
                                                                            "object",
                                                                            "null"
                                                                        ],
                                                                        "description": "Who it came from, or null when the transaction names nobody.",
                                                                        "properties": {
                                                                            "name": {
                                                                                "type": [
                                                                                    "string",
                                                                                    "null"
                                                                                ],
                                                                                "description": "The counterparty of the acquisition transaction, as text."
                                                                            }
                                                                        }
                                                                    },
                                                                    "acquired_on": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The day of the acquisition transaction, written as 2005-03-24, or null."
                                                                    },
                                                                    "transaction_id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the acquisition transaction, or null."
                                                                    },
                                                                    "declared_value": {
                                                                        "type": [
                                                                            "object",
                                                                            "null"
                                                                        ],
                                                                        "description": "What it would cost to replace today, or null.",
                                                                        "properties": {
                                                                            "amount": {
                                                                                "type": [
                                                                                    "string",
                                                                                    "null"
                                                                                ],
                                                                                "description": "The amount, a decimal with two digits after the point, such as 12.99."
                                                                            },
                                                                            "currency": {
                                                                                "type": [
                                                                                    "string",
                                                                                    "null"
                                                                                ],
                                                                                "description": "The currency: usd, eur, gbp, cad, aud, chf, jpy, brl, inr or cny."
                                                                            }
                                                                        }
                                                                    }
                                                                }
                                                            },
                                                            "current_value": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "What the thing is worth now: its latest valuation, else its declared value, else null. Read from its valuations, so it cannot be written here.",
                                                                "properties": {
                                                                    "amount": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The amount, a decimal with two digits after the point, such as 15.00."
                                                                    },
                                                                    "currency": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The currency of the amount, in lower case. Nothing is ever converted."
                                                                    },
                                                                    "source": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Where the amount comes from: valuation or declared_value."
                                                                    }
                                                                }
                                                            },
                                                            "tags": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "The tags the thing carries, sorted by name.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One tag.",
                                                                    "properties": {
                                                                        "id": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "format": "uuid",
                                                                            "description": "The id of the tag."
                                                                        },
                                                                        "name": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "What the tag reads."
                                                                        },
                                                                        "colour": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The colour of the tag, as a hexadecimal value."
                                                                        }
                                                                    }
                                                                }
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the possession was added, as a count of seconds since 1970."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "possession",
                                            "id": "6e2b9d41-8c37-4f15-a0d6-3b7e1c9f2a84",
                                            "attributes": {
                                                "name": "World’s Best Boss mug",
                                                "description": "Bought by Michael for Michael, from Spencer Gifts.",
                                                "identifier": "WBB-0001",
                                                "status": "owned",
                                                "quantity": 1,
                                                "is_featured": true,
                                                "position": 1,
                                                "possession_type": {
                                                    "id": "9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35",
                                                    "name": "Office equipment",
                                                    "colour": "#2f7f86",
                                                    "icon": "briefcase"
                                                },
                                                "location": {
                                                    "id": "5b7e2c90-4d18-4a3f-9e61-0c8d2f7a1b43",
                                                    "name": "Dunder Mifflin Scranton"
                                                },
                                                "values": [
                                                    {
                                                        "field_id": "b7e04a93-1c6f-4d28-9a35-6f8e2d1c4b90",
                                                        "name": "Payment method",
                                                        "kind": "select",
                                                        "group": "Purchase",
                                                        "value": "Card"
                                                    },
                                                    {
                                                        "field_id": "e5c37a28-9f14-4b6d-a083-7d2e1f9b6c45",
                                                        "name": "Condition",
                                                        "kind": "select",
                                                        "group": null,
                                                        "value": "Used"
                                                    },
                                                    {
                                                        "field_id": "2d8b5f1e-6a47-4c93-8e02-1b9f7c3a5d64",
                                                        "name": "Serial number",
                                                        "kind": "text",
                                                        "group": null,
                                                        "value": "SG-2005-0324"
                                                    }
                                                ],
                                                "acquisition": {
                                                    "way": "gift_received",
                                                    "acquired_from": {
                                                        "name": "Jim Halpert"
                                                    },
                                                    "acquired_on": "2005-03-24",
                                                    "transaction_id": "8f3a6c21-4e97-4b05-9d18-7a2c5e0f9b36",
                                                    "declared_value": {
                                                        "amount": "12.99",
                                                        "currency": "usd"
                                                    }
                                                },
                                                "current_value": {
                                                    "amount": "15.00",
                                                    "currency": "usd",
                                                    "source": "valuation"
                                                },
                                                "tags": [
                                                    {
                                                        "id": "1e6b9d47-3c28-4f71-a5e0-9d4c2b8f6a13",
                                                        "name": "insured",
                                                        "colour": "#3f5fd0"
                                                    }
                                                ],
                                                "created_at": 1761523200,
                                                "updated_at": 1761526800
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/6e2b9d41-8c37-4f15-a0d6-3b7e1c9f2a84"
                                            }
                                        },
                                        {
                                            "type": "possession",
                                            "id": "c4f81a27-5d93-4e60-b2a8-9e1d7c3b5f06",
                                            "attributes": {
                                                "name": "Chrysler Sebring",
                                                "description": "Bought with the first commission check. Drove into a lake once, following the GPS.",
                                                "identifier": null,
                                                "status": "owned",
                                                "quantity": 1,
                                                "is_featured": false,
                                                "position": null,
                                                "possession_type": {
                                                    "id": "3a7f5c19-2e84-4d6b-9f03-8c1b6e4a2d57",
                                                    "name": "Vehicle",
                                                    "colour": "#3f5fd0",
                                                    "icon": "car"
                                                },
                                                "location": {
                                                    "id": "f19c3e6a-7b42-4d85-a0e7-2c6d9b1f8a34",
                                                    "name": "Scranton parking lot"
                                                },
                                                "values": [],
                                                "acquisition": {
                                                    "way": null,
                                                    "acquired_from": null,
                                                    "acquired_on": null,
                                                    "transaction_id": null,
                                                    "declared_value": null
                                                },
                                                "current_value": null,
                                                "tags": [],
                                                "created_at": 1761526800,
                                                "updated_at": 1761526800
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/c4f81a27-5d93-4e60-b2a8-9e1d7c3b5f06"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 2
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "possessions-index-query",
                "tags": [
                    "Possessions"
                ],
                "summary": "List possessions",
                "description": "List the possessions of a vault, sorted by name, each with its type, its location and its values.\n\nA possession belongs to a vault. Its type and its location belong to the account, so the same type and the same location serve every vault.\n\nSorted by position, the featured possessions come first in their order, followed by every other possession sorted by name.\n\nTo go through everything a vault holds, ask for compact possessions with the largest page.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "type": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "Only the possessions of this possession type."
                                    },
                                    "status": {
                                        "type": "string",
                                        "description": "Only the possessions with this status: owned, ordered, sold, given_away, lost, stolen or thrown_away."
                                    },
                                    "featured": {
                                        "type": "boolean",
                                        "description": "Only the featured possessions when true, only the others when false."
                                    },
                                    "location": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "Only the possessions kept at this location or at any location inside it. A location that is not one of the account answers 422."
                                    },
                                    "sort": {
                                        "type": "string",
                                        "default": "name",
                                        "description": "Either name or position."
                                    },
                                    "compact": {
                                        "type": "boolean",
                                        "default": false,
                                        "description": "When true, each possession carries only its name, its status, the id and name of its type, its location and its current value, which is about a tenth of the full record. Get one possession for the rest."
                                    },
                                    "page": {
                                        "type": "integer",
                                        "default": 1,
                                        "description": "Which page to answer with."
                                    },
                                    "per_page": {
                                        "type": "integer",
                                        "default": 25,
                                        "description": "How many possessions one page holds, between 1 and 100. A number outside the range is brought back into it."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "A page of possession objects, and how many there are in all. A vault with none answers an empty list, and a vault of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The possessions on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One possession.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always possession. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the thing is called, such as World’s Best Boss mug."
                                                            },
                                                            "description": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Free text about the thing, or null."
                                                            },
                                                            "identifier": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "A serial number, a licence plate or any other reference written on the thing, or null."
                                                            },
                                                            "status": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Where the thing stands: owned, ordered, sold, given_away, lost, stolen or thrown_away."
                                                            },
                                                            "quantity": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How many of the thing there are, at least 1."
                                                            },
                                                            "is_featured": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the thing is featured, which places it in the order shown first in the vault."
                                                            },
                                                            "position": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "Its place among the featured possessions of the vault, counting from 1, or null when it is not featured."
                                                            },
                                                            "possession_type": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The kind of thing it is. It is chosen when the possession is added and never changes.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the possession type."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the type is called."
                                                                    },
                                                                    "colour": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The colour of the type, as a hexadecimal value."
                                                                    },
                                                                    "icon": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The icon of the type, one of the glyphs of the catalogue, or null."
                                                                    }
                                                                }
                                                            },
                                                            "location": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "Where the thing is kept now, or null when nobody said.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the location."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the location is called."
                                                                    }
                                                                }
                                                            },
                                                            "values": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "What the thing holds for the fields of its type, in the order of the fields: the groups first, then the standalone fields. A field holding nothing is left out.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One value.",
                                                                    "properties": {
                                                                        "field_id": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "format": "uuid",
                                                                            "description": "The id of the field, which is the key to send when writing its value."
                                                                        },
                                                                        "name": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "What the field is called."
                                                                        },
                                                                        "kind": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "What the field holds: text, number, date, boolean, select or rating."
                                                                        },
                                                                        "group": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The name of the group the field sits in, or null when it stands alone."
                                                                        },
                                                                        "value": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The value, as the kind of the field reads it: a string for text, a date written as 2005-03-24 and a choice, a number for a number, an integer from 1 to 5 for a rating, and true or false for a boolean."
                                                                        }
                                                                    }
                                                                }
                                                            },
                                                            "acquisition": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "How the thing was acquired, read from its acquisition transaction: the earliest purchase, exchange, gift received or inheritance. Each part is null without one. Change it through the transactions, since none of it can be written here.",
                                                                "properties": {
                                                                    "way": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The type of the acquisition transaction: purchase, exchange, gift_received or inheritance, or null."
                                                                    },
                                                                    "acquired_from": {
                                                                        "type": [
                                                                            "object",
                                                                            "null"
                                                                        ],
                                                                        "description": "Who it came from, or null when the transaction names nobody.",
                                                                        "properties": {
                                                                            "name": {
                                                                                "type": [
                                                                                    "string",
                                                                                    "null"
                                                                                ],
                                                                                "description": "The counterparty of the acquisition transaction, as text."
                                                                            }
                                                                        }
                                                                    },
                                                                    "acquired_on": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The day of the acquisition transaction, written as 2005-03-24, or null."
                                                                    },
                                                                    "transaction_id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the acquisition transaction, or null."
                                                                    },
                                                                    "declared_value": {
                                                                        "type": [
                                                                            "object",
                                                                            "null"
                                                                        ],
                                                                        "description": "What it would cost to replace today, or null.",
                                                                        "properties": {
                                                                            "amount": {
                                                                                "type": [
                                                                                    "string",
                                                                                    "null"
                                                                                ],
                                                                                "description": "The amount, a decimal with two digits after the point, such as 12.99."
                                                                            },
                                                                            "currency": {
                                                                                "type": [
                                                                                    "string",
                                                                                    "null"
                                                                                ],
                                                                                "description": "The currency: usd, eur, gbp, cad, aud, chf, jpy, brl, inr or cny."
                                                                            }
                                                                        }
                                                                    }
                                                                }
                                                            },
                                                            "current_value": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "What the thing is worth now: its latest valuation, else its declared value, else null. Read from its valuations, so it cannot be written here.",
                                                                "properties": {
                                                                    "amount": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The amount, a decimal with two digits after the point, such as 15.00."
                                                                    },
                                                                    "currency": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The currency of the amount, in lower case. Nothing is ever converted."
                                                                    },
                                                                    "source": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Where the amount comes from: valuation or declared_value."
                                                                    }
                                                                }
                                                            },
                                                            "tags": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "The tags the thing carries, sorted by name.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One tag.",
                                                                    "properties": {
                                                                        "id": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "format": "uuid",
                                                                            "description": "The id of the tag."
                                                                        },
                                                                        "name": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "What the tag reads."
                                                                        },
                                                                        "colour": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The colour of the tag, as a hexadecimal value."
                                                                        }
                                                                    }
                                                                }
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the possession was added, as a count of seconds since 1970."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "possession",
                                            "id": "6e2b9d41-8c37-4f15-a0d6-3b7e1c9f2a84",
                                            "attributes": {
                                                "name": "World’s Best Boss mug",
                                                "description": "Bought by Michael for Michael, from Spencer Gifts.",
                                                "identifier": "WBB-0001",
                                                "status": "owned",
                                                "quantity": 1,
                                                "is_featured": true,
                                                "position": 1,
                                                "possession_type": {
                                                    "id": "9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35",
                                                    "name": "Office equipment",
                                                    "colour": "#2f7f86",
                                                    "icon": "briefcase"
                                                },
                                                "location": {
                                                    "id": "5b7e2c90-4d18-4a3f-9e61-0c8d2f7a1b43",
                                                    "name": "Dunder Mifflin Scranton"
                                                },
                                                "values": [
                                                    {
                                                        "field_id": "b7e04a93-1c6f-4d28-9a35-6f8e2d1c4b90",
                                                        "name": "Payment method",
                                                        "kind": "select",
                                                        "group": "Purchase",
                                                        "value": "Card"
                                                    },
                                                    {
                                                        "field_id": "e5c37a28-9f14-4b6d-a083-7d2e1f9b6c45",
                                                        "name": "Condition",
                                                        "kind": "select",
                                                        "group": null,
                                                        "value": "Used"
                                                    },
                                                    {
                                                        "field_id": "2d8b5f1e-6a47-4c93-8e02-1b9f7c3a5d64",
                                                        "name": "Serial number",
                                                        "kind": "text",
                                                        "group": null,
                                                        "value": "SG-2005-0324"
                                                    }
                                                ],
                                                "acquisition": {
                                                    "way": "gift_received",
                                                    "acquired_from": {
                                                        "name": "Jim Halpert"
                                                    },
                                                    "acquired_on": "2005-03-24",
                                                    "transaction_id": "8f3a6c21-4e97-4b05-9d18-7a2c5e0f9b36",
                                                    "declared_value": {
                                                        "amount": "12.99",
                                                        "currency": "usd"
                                                    }
                                                },
                                                "current_value": {
                                                    "amount": "15.00",
                                                    "currency": "usd",
                                                    "source": "valuation"
                                                },
                                                "tags": [
                                                    {
                                                        "id": "1e6b9d47-3c28-4f71-a5e0-9d4c2b8f6a13",
                                                        "name": "insured",
                                                        "colour": "#3f5fd0"
                                                    }
                                                ],
                                                "created_at": 1761523200,
                                                "updated_at": 1761526800
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/6e2b9d41-8c37-4f15-a0d6-3b7e1c9f2a84"
                                            }
                                        },
                                        {
                                            "type": "possession",
                                            "id": "c4f81a27-5d93-4e60-b2a8-9e1d7c3b5f06",
                                            "attributes": {
                                                "name": "Chrysler Sebring",
                                                "description": "Bought with the first commission check. Drove into a lake once, following the GPS.",
                                                "identifier": null,
                                                "status": "owned",
                                                "quantity": 1,
                                                "is_featured": false,
                                                "position": null,
                                                "possession_type": {
                                                    "id": "3a7f5c19-2e84-4d6b-9f03-8c1b6e4a2d57",
                                                    "name": "Vehicle",
                                                    "colour": "#3f5fd0",
                                                    "icon": "car"
                                                },
                                                "location": {
                                                    "id": "f19c3e6a-7b42-4d85-a0e7-2c6d9b1f8a34",
                                                    "name": "Scranton parking lot"
                                                },
                                                "values": [],
                                                "acquisition": {
                                                    "way": null,
                                                    "acquired_from": null,
                                                    "acquired_on": null,
                                                    "transaction_id": null,
                                                    "declared_value": null
                                                },
                                                "current_value": null,
                                                "tags": [],
                                                "created_at": 1761526800,
                                                "updated_at": 1761526800
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/c4f81a27-5d93-4e60-b2a8-9e1d7c3b5f06"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 2
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "post": {
                "operationId": "possessions-create",
                "tags": [
                    "Possessions"
                ],
                "summary": "Add a possession",
                "description": "Record something kept in a vault. Write the values of its fields afterwards.\n\nHow it was acquired is not written here: record it as a transaction of the possession. Sending acquisition, acquired_from_id or acquired_on answers 422.\n\nLeft out, a possession is owned, counts one and is not featured.\n\nA type or a location of another account answers 422 on type_id or location_id. The change is written to the account log.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "type_id": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "The possession type of the thing. A type of another account is refused. The type cannot be changed later."
                                    },
                                    "name": {
                                        "type": "string",
                                        "description": "What the thing is called. Up to 255 characters. Markup and surrounding blank space are stripped, and a name left with nothing in it is refused with “Write a name for this possession.”"
                                    },
                                    "description": {
                                        "type": "string",
                                        "description": "Free text about the thing, up to 2,000 characters. Null or blank, there is none."
                                    },
                                    "location_id": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "The location the thing is kept in. Null, there is none. A location of another account is refused."
                                    },
                                    "identifier": {
                                        "type": "string",
                                        "description": "A serial number, a licence plate or any other reference, up to 255 characters. Null or blank, there is none."
                                    },
                                    "status": {
                                        "type": "string",
                                        "default": "owned",
                                        "description": "One of owned, ordered, sold, given_away, lost, stolen or thrown_away."
                                    },
                                    "quantity": {
                                        "type": "integer",
                                        "default": 1,
                                        "description": "How many there are, between 1 and 1,000,000."
                                    },
                                    "is_featured": {
                                        "type": "boolean",
                                        "default": false,
                                        "description": "Whether the thing is featured. A possession becoming featured is placed last among the featured possessions of the vault."
                                    },
                                    "declared_value": {
                                        "type": "string",
                                        "description": "What it would cost to replace today, from 0 to 9999999999.99, kept with two decimals."
                                    },
                                    "declared_value_currency": {
                                        "type": "string",
                                        "description": "The currency of the declared value: usd, eur, gbp, cad, aud, chf, jpy, brl, inr or cny. Required with a value, and dropped without one."
                                    },
                                    "tags": {
                                        "type": "array",
                                        "description": "The names of the tags the thing carries, each up to 50 characters. A name matching a tag of the account, ignoring case, uses that tag; any other name creates a tag in the account."
                                    }
                                },
                                "required": [
                                    "type_id",
                                    "name"
                                ]
                            },
                            "example": {
                                "type_id": "9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35",
                                "name": "World’s Best Boss mug",
                                "description": "Bought by Michael for Michael, from Spencer Gifts.",
                                "location_id": "5b7e2c90-4d18-4a3f-9e61-0c8d2f7a1b43",
                                "identifier": "WBB-0001",
                                "status": "owned",
                                "quantity": 1,
                                "is_featured": true,
                                "declared_value": 12.99,
                                "declared_value_currency": "usd",
                                "tags": [
                                    "insured"
                                ]
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The possession object that was added, holding no value yet.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the thing is called, such as World’s Best Boss mug."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Free text about the thing, or null."
                                                        },
                                                        "identifier": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "A serial number, a licence plate or any other reference written on the thing, or null."
                                                        },
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the thing stands: owned, ordered, sold, given_away, lost, stolen or thrown_away."
                                                        },
                                                        "quantity": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many of the thing there are, at least 1."
                                                        },
                                                        "is_featured": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the thing is featured, which places it in the order shown first in the vault."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Its place among the featured possessions of the vault, counting from 1, or null when it is not featured."
                                                        },
                                                        "possession_type": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The kind of thing it is. It is chosen when the possession is added and never changes.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the possession type."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What the type is called."
                                                                },
                                                                "colour": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The colour of the type, as a hexadecimal value."
                                                                },
                                                                "icon": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The icon of the type, one of the glyphs of the catalogue, or null."
                                                                }
                                                            }
                                                        },
                                                        "location": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "Where the thing is kept now, or null when nobody said.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the location."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What the location is called."
                                                                }
                                                            }
                                                        },
                                                        "values": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "What the thing holds for the fields of its type, an empty list for a new possession."
                                                        },
                                                        "acquisition": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "How the thing was acquired, read from its acquisition transaction: the earliest purchase, exchange, gift received or inheritance. Each part is null without one. Change it through the transactions, since none of it can be written here.",
                                                            "properties": {
                                                                "way": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The type of the acquisition transaction: purchase, exchange, gift_received or inheritance, or null."
                                                                },
                                                                "acquired_from": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "Who it came from, or null when the transaction names nobody."
                                                                },
                                                                "acquired_on": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The day of the acquisition transaction, written as 2005-03-24, or null."
                                                                },
                                                                "transaction_id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the acquisition transaction, or null."
                                                                },
                                                                "declared_value": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "What it would cost to replace today, or null.",
                                                                    "properties": {
                                                                        "amount": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The amount, a decimal with two digits after the point, such as 12.99."
                                                                        },
                                                                        "currency": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The currency: usd, eur, gbp, cad, aud, chf, jpy, brl, inr or cny."
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "current_value": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "What the thing is worth now: its latest valuation, else its declared value, else null. Read from its valuations, so it cannot be written here.",
                                                            "properties": {
                                                                "amount": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The amount, a decimal with two digits after the point, such as 15.00."
                                                                },
                                                                "currency": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The currency of the amount, in lower case. Nothing is ever converted."
                                                                },
                                                                "source": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "Where the amount comes from: valuation or declared_value."
                                                                }
                                                            }
                                                        },
                                                        "tags": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The tags the thing carries, sorted by name.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One tag.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the tag."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the tag reads."
                                                                    },
                                                                    "colour": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The colour of the tag, as a hexadecimal value."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the possession was added, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession",
                                        "id": "6e2b9d41-8c37-4f15-a0d6-3b7e1c9f2a84",
                                        "attributes": {
                                            "name": "World’s Best Boss mug",
                                            "description": "Bought by Michael for Michael, from Spencer Gifts.",
                                            "identifier": "WBB-0001",
                                            "status": "owned",
                                            "quantity": 1,
                                            "is_featured": true,
                                            "position": 1,
                                            "possession_type": {
                                                "id": "9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35",
                                                "name": "Office equipment",
                                                "colour": "#2f7f86",
                                                "icon": "briefcase"
                                            },
                                            "location": {
                                                "id": "5b7e2c90-4d18-4a3f-9e61-0c8d2f7a1b43",
                                                "name": "Dunder Mifflin Scranton"
                                            },
                                            "values": [],
                                            "acquisition": {
                                                "way": null,
                                                "acquired_from": null,
                                                "acquired_on": null,
                                                "transaction_id": null,
                                                "declared_value": {
                                                    "amount": "12.99",
                                                    "currency": "usd"
                                                }
                                            },
                                            "current_value": {
                                                "amount": "12.99",
                                                "currency": "usd",
                                                "source": "declared_value"
                                            },
                                            "tags": [
                                                {
                                                    "id": "1e6b9d47-3c28-4f71-a5e0-9d4c2b8f6a13",
                                                    "name": "insured",
                                                    "colour": "#3f5fd0"
                                                }
                                            ],
                                            "created_at": 1761523200,
                                            "updated_at": 1761523200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/6e2b9d41-8c37-4f15-a0d6-3b7e1c9f2a84"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/possessions/{possession}": {
            "get": {
                "operationId": "possessions-show",
                "tags": [
                    "Possessions"
                ],
                "summary": "Get a possession",
                "description": "Retrieve one possession with its type, its location and its values.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A possession object. A vault or a possession of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the thing is called, such as World’s Best Boss mug."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Free text about the thing, or null."
                                                        },
                                                        "identifier": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "A serial number, a licence plate or any other reference written on the thing, or null."
                                                        },
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the thing stands: owned, ordered, sold, given_away, lost, stolen or thrown_away."
                                                        },
                                                        "quantity": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many of the thing there are, at least 1."
                                                        },
                                                        "is_featured": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the thing is featured, which places it in the order shown first in the vault."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Its place among the featured possessions of the vault, counting from 1, or null when it is not featured."
                                                        },
                                                        "possession_type": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The kind of thing it is. It is chosen when the possession is added and never changes.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the possession type."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What the type is called."
                                                                },
                                                                "colour": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The colour of the type, as a hexadecimal value."
                                                                },
                                                                "icon": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The icon of the type, one of the glyphs of the catalogue, or null."
                                                                }
                                                            }
                                                        },
                                                        "location": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "Where the thing is kept now, or null when nobody said.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the location."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What the location is called."
                                                                }
                                                            }
                                                        },
                                                        "values": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "What the thing holds for the fields of its type, in the order of the fields: the groups first, then the standalone fields. A field holding nothing is left out.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One value.",
                                                                "properties": {
                                                                    "field_id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the field, which is the key to send when writing its value."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field is called."
                                                                    },
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field holds: text, number, date, boolean, select or rating."
                                                                    },
                                                                    "group": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name of the group the field sits in, or null when it stands alone."
                                                                    },
                                                                    "value": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The value, as the kind of the field reads it: a string for text, a date written as 2005-03-24 and a choice, a number for a number, an integer from 1 to 5 for a rating, and true or false for a boolean."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "acquisition": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "How the thing was acquired, read from its acquisition transaction: the earliest purchase, exchange, gift received or inheritance. Each part is null without one. Change it through the transactions, since none of it can be written here.",
                                                            "properties": {
                                                                "way": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The type of the acquisition transaction: purchase, exchange, gift_received or inheritance, or null."
                                                                },
                                                                "acquired_from": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "Who it came from, or null when the transaction names nobody.",
                                                                    "properties": {
                                                                        "name": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The counterparty of the acquisition transaction, as text."
                                                                        }
                                                                    }
                                                                },
                                                                "acquired_on": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The day of the acquisition transaction, written as 2005-03-24, or null."
                                                                },
                                                                "transaction_id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the acquisition transaction, or null."
                                                                },
                                                                "declared_value": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "What it would cost to replace today, or null.",
                                                                    "properties": {
                                                                        "amount": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The amount, a decimal with two digits after the point, such as 12.99."
                                                                        },
                                                                        "currency": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The currency: usd, eur, gbp, cad, aud, chf, jpy, brl, inr or cny."
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "current_value": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "What the thing is worth now: its latest valuation, else its declared value, else null. Read from its valuations, so it cannot be written here.",
                                                            "properties": {
                                                                "amount": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The amount, a decimal with two digits after the point, such as 15.00."
                                                                },
                                                                "currency": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The currency of the amount, in lower case. Nothing is ever converted."
                                                                },
                                                                "source": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "Where the amount comes from: valuation or declared_value."
                                                                }
                                                            }
                                                        },
                                                        "tags": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The tags the thing carries, sorted by name.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One tag.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the tag."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the tag reads."
                                                                    },
                                                                    "colour": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The colour of the tag, as a hexadecimal value."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the possession was added, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession",
                                        "id": "6e2b9d41-8c37-4f15-a0d6-3b7e1c9f2a84",
                                        "attributes": {
                                            "name": "World’s Best Boss mug",
                                            "description": "Bought by Michael for Michael, from Spencer Gifts.",
                                            "identifier": "WBB-0001",
                                            "status": "owned",
                                            "quantity": 1,
                                            "is_featured": true,
                                            "position": 1,
                                            "possession_type": {
                                                "id": "9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35",
                                                "name": "Office equipment",
                                                "colour": "#2f7f86",
                                                "icon": "briefcase"
                                            },
                                            "location": {
                                                "id": "5b7e2c90-4d18-4a3f-9e61-0c8d2f7a1b43",
                                                "name": "Dunder Mifflin Scranton"
                                            },
                                            "values": [
                                                {
                                                    "field_id": "b7e04a93-1c6f-4d28-9a35-6f8e2d1c4b90",
                                                    "name": "Payment method",
                                                    "kind": "select",
                                                    "group": "Purchase",
                                                    "value": "Card"
                                                },
                                                {
                                                    "field_id": "e5c37a28-9f14-4b6d-a083-7d2e1f9b6c45",
                                                    "name": "Condition",
                                                    "kind": "select",
                                                    "group": null,
                                                    "value": "Used"
                                                },
                                                {
                                                    "field_id": "2d8b5f1e-6a47-4c93-8e02-1b9f7c3a5d64",
                                                    "name": "Serial number",
                                                    "kind": "text",
                                                    "group": null,
                                                    "value": "SG-2005-0324"
                                                }
                                            ],
                                            "acquisition": {
                                                "way": "gift_received",
                                                "acquired_from": {
                                                    "name": "Jim Halpert"
                                                },
                                                "acquired_on": "2005-03-24",
                                                "transaction_id": "8f3a6c21-4e97-4b05-9d18-7a2c5e0f9b36",
                                                "declared_value": {
                                                    "amount": "12.99",
                                                    "currency": "usd"
                                                }
                                            },
                                            "current_value": {
                                                "amount": "15.00",
                                                "currency": "usd",
                                                "source": "valuation"
                                            },
                                            "tags": [
                                                {
                                                    "id": "1e6b9d47-3c28-4f71-a5e0-9d4c2b8f6a13",
                                                    "name": "insured",
                                                    "colour": "#3f5fd0"
                                                }
                                            ],
                                            "created_at": 1761523200,
                                            "updated_at": 1761526800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/6e2b9d41-8c37-4f15-a0d6-3b7e1c9f2a84"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "possessions-show-query",
                "tags": [
                    "Possessions"
                ],
                "summary": "Get a possession",
                "description": "Retrieve one possession with its type, its location and its values.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A possession object. A vault or a possession of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the thing is called, such as World’s Best Boss mug."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Free text about the thing, or null."
                                                        },
                                                        "identifier": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "A serial number, a licence plate or any other reference written on the thing, or null."
                                                        },
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the thing stands: owned, ordered, sold, given_away, lost, stolen or thrown_away."
                                                        },
                                                        "quantity": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many of the thing there are, at least 1."
                                                        },
                                                        "is_featured": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the thing is featured, which places it in the order shown first in the vault."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Its place among the featured possessions of the vault, counting from 1, or null when it is not featured."
                                                        },
                                                        "possession_type": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The kind of thing it is. It is chosen when the possession is added and never changes.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the possession type."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What the type is called."
                                                                },
                                                                "colour": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The colour of the type, as a hexadecimal value."
                                                                },
                                                                "icon": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The icon of the type, one of the glyphs of the catalogue, or null."
                                                                }
                                                            }
                                                        },
                                                        "location": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "Where the thing is kept now, or null when nobody said.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the location."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What the location is called."
                                                                }
                                                            }
                                                        },
                                                        "values": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "What the thing holds for the fields of its type, in the order of the fields: the groups first, then the standalone fields. A field holding nothing is left out.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One value.",
                                                                "properties": {
                                                                    "field_id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the field, which is the key to send when writing its value."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field is called."
                                                                    },
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field holds: text, number, date, boolean, select or rating."
                                                                    },
                                                                    "group": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name of the group the field sits in, or null when it stands alone."
                                                                    },
                                                                    "value": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The value, as the kind of the field reads it: a string for text, a date written as 2005-03-24 and a choice, a number for a number, an integer from 1 to 5 for a rating, and true or false for a boolean."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "acquisition": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "How the thing was acquired, read from its acquisition transaction: the earliest purchase, exchange, gift received or inheritance. Each part is null without one. Change it through the transactions, since none of it can be written here.",
                                                            "properties": {
                                                                "way": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The type of the acquisition transaction: purchase, exchange, gift_received or inheritance, or null."
                                                                },
                                                                "acquired_from": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "Who it came from, or null when the transaction names nobody.",
                                                                    "properties": {
                                                                        "name": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The counterparty of the acquisition transaction, as text."
                                                                        }
                                                                    }
                                                                },
                                                                "acquired_on": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The day of the acquisition transaction, written as 2005-03-24, or null."
                                                                },
                                                                "transaction_id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the acquisition transaction, or null."
                                                                },
                                                                "declared_value": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "What it would cost to replace today, or null.",
                                                                    "properties": {
                                                                        "amount": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The amount, a decimal with two digits after the point, such as 12.99."
                                                                        },
                                                                        "currency": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The currency: usd, eur, gbp, cad, aud, chf, jpy, brl, inr or cny."
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "current_value": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "What the thing is worth now: its latest valuation, else its declared value, else null. Read from its valuations, so it cannot be written here.",
                                                            "properties": {
                                                                "amount": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The amount, a decimal with two digits after the point, such as 15.00."
                                                                },
                                                                "currency": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The currency of the amount, in lower case. Nothing is ever converted."
                                                                },
                                                                "source": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "Where the amount comes from: valuation or declared_value."
                                                                }
                                                            }
                                                        },
                                                        "tags": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The tags the thing carries, sorted by name.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One tag.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the tag."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the tag reads."
                                                                    },
                                                                    "colour": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The colour of the tag, as a hexadecimal value."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the possession was added, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession",
                                        "id": "6e2b9d41-8c37-4f15-a0d6-3b7e1c9f2a84",
                                        "attributes": {
                                            "name": "World’s Best Boss mug",
                                            "description": "Bought by Michael for Michael, from Spencer Gifts.",
                                            "identifier": "WBB-0001",
                                            "status": "owned",
                                            "quantity": 1,
                                            "is_featured": true,
                                            "position": 1,
                                            "possession_type": {
                                                "id": "9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35",
                                                "name": "Office equipment",
                                                "colour": "#2f7f86",
                                                "icon": "briefcase"
                                            },
                                            "location": {
                                                "id": "5b7e2c90-4d18-4a3f-9e61-0c8d2f7a1b43",
                                                "name": "Dunder Mifflin Scranton"
                                            },
                                            "values": [
                                                {
                                                    "field_id": "b7e04a93-1c6f-4d28-9a35-6f8e2d1c4b90",
                                                    "name": "Payment method",
                                                    "kind": "select",
                                                    "group": "Purchase",
                                                    "value": "Card"
                                                },
                                                {
                                                    "field_id": "e5c37a28-9f14-4b6d-a083-7d2e1f9b6c45",
                                                    "name": "Condition",
                                                    "kind": "select",
                                                    "group": null,
                                                    "value": "Used"
                                                },
                                                {
                                                    "field_id": "2d8b5f1e-6a47-4c93-8e02-1b9f7c3a5d64",
                                                    "name": "Serial number",
                                                    "kind": "text",
                                                    "group": null,
                                                    "value": "SG-2005-0324"
                                                }
                                            ],
                                            "acquisition": {
                                                "way": "gift_received",
                                                "acquired_from": {
                                                    "name": "Jim Halpert"
                                                },
                                                "acquired_on": "2005-03-24",
                                                "transaction_id": "8f3a6c21-4e97-4b05-9d18-7a2c5e0f9b36",
                                                "declared_value": {
                                                    "amount": "12.99",
                                                    "currency": "usd"
                                                }
                                            },
                                            "current_value": {
                                                "amount": "15.00",
                                                "currency": "usd",
                                                "source": "valuation"
                                            },
                                            "tags": [
                                                {
                                                    "id": "1e6b9d47-3c28-4f71-a5e0-9d4c2b8f6a13",
                                                    "name": "insured",
                                                    "colour": "#3f5fd0"
                                                }
                                            ],
                                            "created_at": 1761523200,
                                            "updated_at": 1761526800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/6e2b9d41-8c37-4f15-a0d6-3b7e1c9f2a84"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "put": {
                "operationId": "possessions-update",
                "tags": [
                    "Possessions"
                ],
                "summary": "Change a possession",
                "description": "Change what is known of a possession. Its type never changes, and its values are written separately.\n\nHow it was acquired is not written here: record it as a transaction of the possession. Sending acquisition, acquired_from_id or acquired_on answers 422.\n\nSend only what changes. The name, the status, the quantity and is_featured cannot be null. The description, the location, the identifier and the declared value are cleared by null, and tags sent as null or empty remove every tag. Tags sent replace the tags the thing carries.\n\nA possession becoming featured is placed last among the featured possessions of the vault. One that stops being featured leaves the order, and the others close the gap.\n\nA location of another account answers 422 on location_id. The change is written to the account log.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "description": "What the thing is called. Up to 255 characters. Markup and surrounding blank space are stripped, and a name left with nothing in it is refused with “Write a name for this possession.”"
                                    },
                                    "description": {
                                        "type": "string",
                                        "description": "Free text about the thing, up to 2,000 characters. Null or blank, there is none."
                                    },
                                    "location_id": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "The location the thing is kept in. Null, there is none. A location of another account is refused."
                                    },
                                    "identifier": {
                                        "type": "string",
                                        "description": "A serial number, a licence plate or any other reference, up to 255 characters. Null or blank, there is none."
                                    },
                                    "status": {
                                        "type": "string",
                                        "description": "One of owned, ordered, sold, given_away, lost, stolen or thrown_away."
                                    },
                                    "quantity": {
                                        "type": "integer",
                                        "description": "How many there are, between 1 and 1,000,000."
                                    },
                                    "is_featured": {
                                        "type": "boolean",
                                        "description": "Whether the thing is featured. A possession becoming featured is placed last among the featured possessions of the vault."
                                    },
                                    "declared_value": {
                                        "type": "string",
                                        "description": "What it would cost to replace today, from 0 to 9999999999.99, kept with two decimals."
                                    },
                                    "declared_value_currency": {
                                        "type": "string",
                                        "description": "The currency of the declared value: usd, eur, gbp, cad, aud, chf, jpy, brl, inr or cny. Required with a value, and dropped without one."
                                    },
                                    "tags": {
                                        "type": "array",
                                        "description": "The names of the tags the thing carries, each up to 50 characters. A name matching a tag of the account, ignoring case, uses that tag; any other name creates a tag in the account."
                                    }
                                }
                            },
                            "example": {
                                "name": "World’s Best Boss mug",
                                "description": "Bought by Michael for Michael, from Spencer Gifts.",
                                "location_id": "5b7e2c90-4d18-4a3f-9e61-0c8d2f7a1b43",
                                "identifier": "WBB-0001",
                                "status": "owned",
                                "quantity": 1,
                                "is_featured": true,
                                "declared_value": 12.99,
                                "declared_value_currency": "usd",
                                "tags": [
                                    "insured"
                                ]
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The possession object as it now reads. A vault or a possession of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the thing is called, such as World’s Best Boss mug."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Free text about the thing, or null."
                                                        },
                                                        "identifier": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "A serial number, a licence plate or any other reference written on the thing, or null."
                                                        },
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the thing stands: owned, ordered, sold, given_away, lost, stolen or thrown_away."
                                                        },
                                                        "quantity": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many of the thing there are, at least 1."
                                                        },
                                                        "is_featured": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the thing is featured, which places it in the order shown first in the vault."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Its place among the featured possessions of the vault, counting from 1, or null when it is not featured."
                                                        },
                                                        "possession_type": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The kind of thing it is. It is chosen when the possession is added and never changes.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the possession type."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What the type is called."
                                                                },
                                                                "colour": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The colour of the type, as a hexadecimal value."
                                                                },
                                                                "icon": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The icon of the type, one of the glyphs of the catalogue, or null."
                                                                }
                                                            }
                                                        },
                                                        "location": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "Where the thing is kept now, or null when nobody said.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the location."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What the location is called."
                                                                }
                                                            }
                                                        },
                                                        "values": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "What the thing holds for the fields of its type, in the order of the fields: the groups first, then the standalone fields. A field holding nothing is left out.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One value.",
                                                                "properties": {
                                                                    "field_id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the field, which is the key to send when writing its value."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field is called."
                                                                    },
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field holds: text, number, date, boolean, select or rating."
                                                                    },
                                                                    "group": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name of the group the field sits in, or null when it stands alone."
                                                                    },
                                                                    "value": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The value, as the kind of the field reads it: a string for text, a date written as 2005-03-24 and a choice, a number for a number, an integer from 1 to 5 for a rating, and true or false for a boolean."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "acquisition": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "How the thing was acquired, read from its acquisition transaction: the earliest purchase, exchange, gift received or inheritance. Each part is null without one. Change it through the transactions, since none of it can be written here.",
                                                            "properties": {
                                                                "way": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The type of the acquisition transaction: purchase, exchange, gift_received or inheritance, or null."
                                                                },
                                                                "acquired_from": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "Who it came from, or null when the transaction names nobody.",
                                                                    "properties": {
                                                                        "name": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The counterparty of the acquisition transaction, as text."
                                                                        }
                                                                    }
                                                                },
                                                                "acquired_on": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The day of the acquisition transaction, written as 2005-03-24, or null."
                                                                },
                                                                "transaction_id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the acquisition transaction, or null."
                                                                },
                                                                "declared_value": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "What it would cost to replace today, or null.",
                                                                    "properties": {
                                                                        "amount": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The amount, a decimal with two digits after the point, such as 12.99."
                                                                        },
                                                                        "currency": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The currency: usd, eur, gbp, cad, aud, chf, jpy, brl, inr or cny."
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "current_value": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "What the thing is worth now: its latest valuation, else its declared value, else null. Read from its valuations, so it cannot be written here.",
                                                            "properties": {
                                                                "amount": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The amount, a decimal with two digits after the point, such as 15.00."
                                                                },
                                                                "currency": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The currency of the amount, in lower case. Nothing is ever converted."
                                                                },
                                                                "source": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "Where the amount comes from: valuation or declared_value."
                                                                }
                                                            }
                                                        },
                                                        "tags": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The tags the thing carries, sorted by name.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One tag.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the tag."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the tag reads."
                                                                    },
                                                                    "colour": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The colour of the tag, as a hexadecimal value."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the possession was added, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession",
                                        "id": "6e2b9d41-8c37-4f15-a0d6-3b7e1c9f2a84",
                                        "attributes": {
                                            "name": "World’s Best Boss mug",
                                            "description": "Bought by Michael for Michael, from Spencer Gifts.",
                                            "identifier": "WBB-0001",
                                            "status": "owned",
                                            "quantity": 1,
                                            "is_featured": true,
                                            "position": 1,
                                            "possession_type": {
                                                "id": "9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35",
                                                "name": "Office equipment",
                                                "colour": "#2f7f86",
                                                "icon": "briefcase"
                                            },
                                            "location": {
                                                "id": "5b7e2c90-4d18-4a3f-9e61-0c8d2f7a1b43",
                                                "name": "Dunder Mifflin Scranton"
                                            },
                                            "values": [
                                                {
                                                    "field_id": "b7e04a93-1c6f-4d28-9a35-6f8e2d1c4b90",
                                                    "name": "Payment method",
                                                    "kind": "select",
                                                    "group": "Purchase",
                                                    "value": "Card"
                                                },
                                                {
                                                    "field_id": "e5c37a28-9f14-4b6d-a083-7d2e1f9b6c45",
                                                    "name": "Condition",
                                                    "kind": "select",
                                                    "group": null,
                                                    "value": "Used"
                                                },
                                                {
                                                    "field_id": "2d8b5f1e-6a47-4c93-8e02-1b9f7c3a5d64",
                                                    "name": "Serial number",
                                                    "kind": "text",
                                                    "group": null,
                                                    "value": "SG-2005-0324"
                                                }
                                            ],
                                            "acquisition": {
                                                "way": "gift_received",
                                                "acquired_from": {
                                                    "name": "Jim Halpert"
                                                },
                                                "acquired_on": "2005-03-24",
                                                "transaction_id": "8f3a6c21-4e97-4b05-9d18-7a2c5e0f9b36",
                                                "declared_value": {
                                                    "amount": "12.99",
                                                    "currency": "usd"
                                                }
                                            },
                                            "current_value": {
                                                "amount": "15.00",
                                                "currency": "usd",
                                                "source": "valuation"
                                            },
                                            "tags": [
                                                {
                                                    "id": "1e6b9d47-3c28-4f71-a5e0-9d4c2b8f6a13",
                                                    "name": "insured",
                                                    "colour": "#3f5fd0"
                                                }
                                            ],
                                            "created_at": 1761523200,
                                            "updated_at": 1761526800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/6e2b9d41-8c37-4f15-a0d6-3b7e1c9f2a84"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "delete": {
                "operationId": "possessions-destroy",
                "tags": [
                    "Possessions"
                ],
                "summary": "Delete a possession",
                "description": "Delete a possession with the values it held.\n\nThe possession is deleted for good, with the values it held. A featured one leaves the order, and the others close the gap.\n\nThe account log keeps the name of the possession.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Nothing. A vault or a possession of another account answers 404."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/possessions/{possession}/position": {
            "put": {
                "operationId": "possessions-position",
                "tags": [
                    "Possessions"
                ],
                "summary": "Move a featured possession",
                "description": "Move a featured possession to another place among the featured possessions of its vault. Every one of them is numbered again from 1.\n\nA possession that is not featured has no place in the order, and answers 422 on position with “Only a featured possession has a place in the order.”\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "position": {
                                        "type": "integer",
                                        "description": "Where it goes, counting from 1. A number past the end puts it last."
                                    }
                                },
                                "required": [
                                    "position"
                                ]
                            },
                            "example": {
                                "position": 1
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The possession object as it now reads. A vault or a possession of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the thing is called, such as World’s Best Boss mug."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Free text about the thing, or null."
                                                        },
                                                        "identifier": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "A serial number, a licence plate or any other reference written on the thing, or null."
                                                        },
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the thing stands: owned, ordered, sold, given_away, lost, stolen or thrown_away."
                                                        },
                                                        "quantity": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many of the thing there are, at least 1."
                                                        },
                                                        "is_featured": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the thing is featured, which places it in the order shown first in the vault."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Its place among the featured possessions of the vault, counting from 1, or null when it is not featured."
                                                        },
                                                        "possession_type": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The kind of thing it is. It is chosen when the possession is added and never changes.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the possession type."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What the type is called."
                                                                },
                                                                "colour": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The colour of the type, as a hexadecimal value."
                                                                },
                                                                "icon": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The icon of the type, one of the glyphs of the catalogue, or null."
                                                                }
                                                            }
                                                        },
                                                        "location": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "Where the thing is kept now, or null when nobody said.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the location."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What the location is called."
                                                                }
                                                            }
                                                        },
                                                        "values": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "What the thing holds for the fields of its type, in the order of the fields: the groups first, then the standalone fields. A field holding nothing is left out.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One value.",
                                                                "properties": {
                                                                    "field_id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the field, which is the key to send when writing its value."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field is called."
                                                                    },
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field holds: text, number, date, boolean, select or rating."
                                                                    },
                                                                    "group": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name of the group the field sits in, or null when it stands alone."
                                                                    },
                                                                    "value": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The value, as the kind of the field reads it: a string for text, a date written as 2005-03-24 and a choice, a number for a number, an integer from 1 to 5 for a rating, and true or false for a boolean."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "acquisition": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "How the thing was acquired, read from its acquisition transaction: the earliest purchase, exchange, gift received or inheritance. Each part is null without one. Change it through the transactions, since none of it can be written here.",
                                                            "properties": {
                                                                "way": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The type of the acquisition transaction: purchase, exchange, gift_received or inheritance, or null."
                                                                },
                                                                "acquired_from": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "Who it came from, or null when the transaction names nobody.",
                                                                    "properties": {
                                                                        "name": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The counterparty of the acquisition transaction, as text."
                                                                        }
                                                                    }
                                                                },
                                                                "acquired_on": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The day of the acquisition transaction, written as 2005-03-24, or null."
                                                                },
                                                                "transaction_id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the acquisition transaction, or null."
                                                                },
                                                                "declared_value": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "What it would cost to replace today, or null.",
                                                                    "properties": {
                                                                        "amount": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The amount, a decimal with two digits after the point, such as 12.99."
                                                                        },
                                                                        "currency": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The currency: usd, eur, gbp, cad, aud, chf, jpy, brl, inr or cny."
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "current_value": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "What the thing is worth now: its latest valuation, else its declared value, else null. Read from its valuations, so it cannot be written here.",
                                                            "properties": {
                                                                "amount": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The amount, a decimal with two digits after the point, such as 15.00."
                                                                },
                                                                "currency": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The currency of the amount, in lower case. Nothing is ever converted."
                                                                },
                                                                "source": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "Where the amount comes from: valuation or declared_value."
                                                                }
                                                            }
                                                        },
                                                        "tags": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The tags the thing carries, sorted by name.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One tag.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the tag."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the tag reads."
                                                                    },
                                                                    "colour": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The colour of the tag, as a hexadecimal value."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the possession was added, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession",
                                        "id": "6e2b9d41-8c37-4f15-a0d6-3b7e1c9f2a84",
                                        "attributes": {
                                            "name": "World’s Best Boss mug",
                                            "description": "Bought by Michael for Michael, from Spencer Gifts.",
                                            "identifier": "WBB-0001",
                                            "status": "owned",
                                            "quantity": 1,
                                            "is_featured": true,
                                            "position": 1,
                                            "possession_type": {
                                                "id": "9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35",
                                                "name": "Office equipment",
                                                "colour": "#2f7f86",
                                                "icon": "briefcase"
                                            },
                                            "location": {
                                                "id": "5b7e2c90-4d18-4a3f-9e61-0c8d2f7a1b43",
                                                "name": "Dunder Mifflin Scranton"
                                            },
                                            "values": [
                                                {
                                                    "field_id": "b7e04a93-1c6f-4d28-9a35-6f8e2d1c4b90",
                                                    "name": "Payment method",
                                                    "kind": "select",
                                                    "group": "Purchase",
                                                    "value": "Card"
                                                },
                                                {
                                                    "field_id": "e5c37a28-9f14-4b6d-a083-7d2e1f9b6c45",
                                                    "name": "Condition",
                                                    "kind": "select",
                                                    "group": null,
                                                    "value": "Used"
                                                },
                                                {
                                                    "field_id": "2d8b5f1e-6a47-4c93-8e02-1b9f7c3a5d64",
                                                    "name": "Serial number",
                                                    "kind": "text",
                                                    "group": null,
                                                    "value": "SG-2005-0324"
                                                }
                                            ],
                                            "acquisition": {
                                                "way": "gift_received",
                                                "acquired_from": {
                                                    "name": "Jim Halpert"
                                                },
                                                "acquired_on": "2005-03-24",
                                                "transaction_id": "8f3a6c21-4e97-4b05-9d18-7a2c5e0f9b36",
                                                "declared_value": {
                                                    "amount": "12.99",
                                                    "currency": "usd"
                                                }
                                            },
                                            "current_value": {
                                                "amount": "15.00",
                                                "currency": "usd",
                                                "source": "valuation"
                                            },
                                            "tags": [
                                                {
                                                    "id": "1e6b9d47-3c28-4f71-a5e0-9d4c2b8f6a13",
                                                    "name": "insured",
                                                    "colour": "#3f5fd0"
                                                }
                                            ],
                                            "created_at": 1761523200,
                                            "updated_at": 1761526800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/6e2b9d41-8c37-4f15-a0d6-3b7e1c9f2a84"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/possessions/{possession}/values": {
            "put": {
                "operationId": "possessions-values",
                "tags": [
                    "Possessions"
                ],
                "summary": "Write the values of a possession",
                "description": "Write what a possession holds for some fields of its type. Only the fields named change.\n\nA value of null or \"\" removes what the field held. Every value is checked against its field first, and nothing is written unless every one of them fits.\n\nEach value that does not fit answers 422 on values.{field_id}, in the words of its kind: “Write at most 2000 characters in Serial number.”, “Price takes a number.”, “Bought on takes a date written as year, month and day, like 2005-03-24.”, “Insured takes yes or no.”, “Condition takes one of its own choices.” or “Comfort takes a rating from one to five.” A field of another type, or of another account, answers “This field is not a field of the type of this possession.”\n\nThe change is written to the account log.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "values": {
                                        "type": "object",
                                        "description": "The values to write, keyed by the field_id of each field. Text takes up to 2,000 characters, a number takes a number, a date is written as 2005-03-24, a boolean takes true or false, a select field takes one of its own choices, and a rating takes an integer from 1 to 5."
                                    }
                                },
                                "required": [
                                    "values"
                                ]
                            },
                            "example": {
                                "values": {
                                    "b7e04a93-1c6f-4d28-9a35-6f8e2d1c4b90": "Card",
                                    "e5c37a28-9f14-4b6d-a083-7d2e1f9b6c45": "Used",
                                    "2d8b5f1e-6a47-4c93-8e02-1b9f7c3a5d64": "SG-2005-0324"
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The possession object as it now reads. A vault or a possession of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the thing is called, such as World’s Best Boss mug."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Free text about the thing, or null."
                                                        },
                                                        "identifier": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "A serial number, a licence plate or any other reference written on the thing, or null."
                                                        },
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the thing stands: owned, ordered, sold, given_away, lost, stolen or thrown_away."
                                                        },
                                                        "quantity": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many of the thing there are, at least 1."
                                                        },
                                                        "is_featured": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the thing is featured, which places it in the order shown first in the vault."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Its place among the featured possessions of the vault, counting from 1, or null when it is not featured."
                                                        },
                                                        "possession_type": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The kind of thing it is. It is chosen when the possession is added and never changes.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the possession type."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What the type is called."
                                                                },
                                                                "colour": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The colour of the type, as a hexadecimal value."
                                                                },
                                                                "icon": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The icon of the type, one of the glyphs of the catalogue, or null."
                                                                }
                                                            }
                                                        },
                                                        "location": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "Where the thing is kept now, or null when nobody said.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the location."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What the location is called."
                                                                }
                                                            }
                                                        },
                                                        "values": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "What the thing holds for the fields of its type, in the order of the fields: the groups first, then the standalone fields. A field holding nothing is left out.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One value.",
                                                                "properties": {
                                                                    "field_id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the field, which is the key to send when writing its value."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field is called."
                                                                    },
                                                                    "kind": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the field holds: text, number, date, boolean, select or rating."
                                                                    },
                                                                    "group": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name of the group the field sits in, or null when it stands alone."
                                                                    },
                                                                    "value": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The value, as the kind of the field reads it: a string for text, a date written as 2005-03-24 and a choice, a number for a number, an integer from 1 to 5 for a rating, and true or false for a boolean."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "acquisition": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "How the thing was acquired, read from its acquisition transaction: the earliest purchase, exchange, gift received or inheritance. Each part is null without one. Change it through the transactions, since none of it can be written here.",
                                                            "properties": {
                                                                "way": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The type of the acquisition transaction: purchase, exchange, gift_received or inheritance, or null."
                                                                },
                                                                "acquired_from": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "Who it came from, or null when the transaction names nobody.",
                                                                    "properties": {
                                                                        "name": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The counterparty of the acquisition transaction, as text."
                                                                        }
                                                                    }
                                                                },
                                                                "acquired_on": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The day of the acquisition transaction, written as 2005-03-24, or null."
                                                                },
                                                                "transaction_id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the acquisition transaction, or null."
                                                                },
                                                                "declared_value": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "What it would cost to replace today, or null.",
                                                                    "properties": {
                                                                        "amount": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The amount, a decimal with two digits after the point, such as 12.99."
                                                                        },
                                                                        "currency": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The currency: usd, eur, gbp, cad, aud, chf, jpy, brl, inr or cny."
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "current_value": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "What the thing is worth now: its latest valuation, else its declared value, else null. Read from its valuations, so it cannot be written here.",
                                                            "properties": {
                                                                "amount": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The amount, a decimal with two digits after the point, such as 15.00."
                                                                },
                                                                "currency": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The currency of the amount, in lower case. Nothing is ever converted."
                                                                },
                                                                "source": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "Where the amount comes from: valuation or declared_value."
                                                                }
                                                            }
                                                        },
                                                        "tags": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The tags the thing carries, sorted by name.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One tag.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the tag."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the tag reads."
                                                                    },
                                                                    "colour": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The colour of the tag, as a hexadecimal value."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the possession was added, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession",
                                        "id": "6e2b9d41-8c37-4f15-a0d6-3b7e1c9f2a84",
                                        "attributes": {
                                            "name": "World’s Best Boss mug",
                                            "description": "Bought by Michael for Michael, from Spencer Gifts.",
                                            "identifier": "WBB-0001",
                                            "status": "owned",
                                            "quantity": 1,
                                            "is_featured": true,
                                            "position": 1,
                                            "possession_type": {
                                                "id": "9c1d4e7a-3b52-4f86-a0d9-2e7b6c418f35",
                                                "name": "Office equipment",
                                                "colour": "#2f7f86",
                                                "icon": "briefcase"
                                            },
                                            "location": {
                                                "id": "5b7e2c90-4d18-4a3f-9e61-0c8d2f7a1b43",
                                                "name": "Dunder Mifflin Scranton"
                                            },
                                            "values": [
                                                {
                                                    "field_id": "b7e04a93-1c6f-4d28-9a35-6f8e2d1c4b90",
                                                    "name": "Payment method",
                                                    "kind": "select",
                                                    "group": "Purchase",
                                                    "value": "Card"
                                                },
                                                {
                                                    "field_id": "e5c37a28-9f14-4b6d-a083-7d2e1f9b6c45",
                                                    "name": "Condition",
                                                    "kind": "select",
                                                    "group": null,
                                                    "value": "Used"
                                                },
                                                {
                                                    "field_id": "2d8b5f1e-6a47-4c93-8e02-1b9f7c3a5d64",
                                                    "name": "Serial number",
                                                    "kind": "text",
                                                    "group": null,
                                                    "value": "SG-2005-0324"
                                                }
                                            ],
                                            "acquisition": {
                                                "way": "gift_received",
                                                "acquired_from": {
                                                    "name": "Jim Halpert"
                                                },
                                                "acquired_on": "2005-03-24",
                                                "transaction_id": "8f3a6c21-4e97-4b05-9d18-7a2c5e0f9b36",
                                                "declared_value": {
                                                    "amount": "12.99",
                                                    "currency": "usd"
                                                }
                                            },
                                            "current_value": {
                                                "amount": "15.00",
                                                "currency": "usd",
                                                "source": "valuation"
                                            },
                                            "tags": [
                                                {
                                                    "id": "1e6b9d47-3c28-4f71-a5e0-9d4c2b8f6a13",
                                                    "name": "insured",
                                                    "colour": "#3f5fd0"
                                                }
                                            ],
                                            "created_at": 1761523200,
                                            "updated_at": 1761526800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/6e2b9d41-8c37-4f15-a0d6-3b7e1c9f2a84"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/possession-tags": {
            "get": {
                "operationId": "possession-tags-index",
                "tags": [
                    "Possession tags"
                ],
                "summary": "List possession tags",
                "description": "List every possession tag of your account, sorted by name.\n\nA possession tag belongs to the account, not to a vault, as possession types do.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to answer with.",
                        "schema": {
                            "type": "integer",
                            "default": 1
                        }
                    },
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "How many tags one page holds, between 1 and 100. A number outside the range is brought back into it.",
                        "schema": {
                            "type": "integer",
                            "default": 25
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of possession tag objects, and how many there are in all. An account with none answers an empty list.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The possession tags on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One possession tag.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always possession_tag. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the tag reads, such as Insured or To sell."
                                                            },
                                                            "colour": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "One of the eight vault colours, as a hexadecimal value."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the tag was added, as a count of seconds since 1970."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When its name or colour last changed, as a count of seconds, or null."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The settings screen where the tags of the account are managed, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "possession_tag",
                                            "id": "7a3e9c15-2b84-4d60-9f17-c5e8a2d4b031",
                                            "attributes": {
                                                "name": "Insured",
                                                "colour": "#2f7f86",
                                                "created_at": 1761436800,
                                                "updated_at": 1761440400
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/possession-tags/7a3e9c15-2b84-4d60-9f17-c5e8a2d4b031",
                                                "web": "https://my.monicahq.com/settings/account/possession-tags"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "possession-tags-index-query",
                "tags": [
                    "Possession tags"
                ],
                "summary": "List possession tags",
                "description": "List every possession tag of your account, sorted by name.\n\nA possession tag belongs to the account, not to a vault, as possession types do.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "page": {
                                        "type": "integer",
                                        "default": 1,
                                        "description": "Which page to answer with."
                                    },
                                    "per_page": {
                                        "type": "integer",
                                        "default": 25,
                                        "description": "How many tags one page holds, between 1 and 100. A number outside the range is brought back into it."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "A page of possession tag objects, and how many there are in all. An account with none answers an empty list.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The possession tags on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One possession tag.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always possession_tag. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the tag reads, such as Insured or To sell."
                                                            },
                                                            "colour": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "One of the eight vault colours, as a hexadecimal value."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the tag was added, as a count of seconds since 1970."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When its name or colour last changed, as a count of seconds, or null."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The settings screen where the tags of the account are managed, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "possession_tag",
                                            "id": "7a3e9c15-2b84-4d60-9f17-c5e8a2d4b031",
                                            "attributes": {
                                                "name": "Insured",
                                                "colour": "#2f7f86",
                                                "created_at": 1761436800,
                                                "updated_at": 1761440400
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/possession-tags/7a3e9c15-2b84-4d60-9f17-c5e8a2d4b031",
                                                "web": "https://my.monicahq.com/settings/account/possession-tags"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "post": {
                "operationId": "possession-tags-create",
                "tags": [
                    "Possession tags"
                ],
                "summary": "Add a possession tag",
                "description": "Add a word your account can put on its possessions.\n\nThe change is written to the account log.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "description": "What the tag reads. Up to 50 characters. Markup and surrounding blank space are stripped, and a name left with nothing in it is refused. A name another tag of the account already has, ignoring case, is refused with “You already have a tag with this name.”"
                                    },
                                    "colour": {
                                        "type": "string",
                                        "description": "One of the vault colours: #3f5fd0, #4f8a49, #9a6a24, #9a3f2b, #6b4fa8, #2f7f86, #a8447a or #4a4a52. Blue when left out."
                                    }
                                },
                                "required": [
                                    "name"
                                ]
                            },
                            "example": {
                                "name": "Heirloom",
                                "colour": "#3f5fd0"
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The possession tag object that was added.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession tag.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_tag. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the tag reads, such as Insured or To sell."
                                                        },
                                                        "colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of the eight vault colours, as a hexadecimal value."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the tag was added, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When its name or colour last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The settings screen where the tags of the account are managed, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_tag",
                                        "id": "7a3e9c15-2b84-4d60-9f17-c5e8a2d4b031",
                                        "attributes": {
                                            "name": "Heirloom",
                                            "colour": "#3f5fd0",
                                            "created_at": 1761436800,
                                            "updated_at": 1761436800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/possession-tags/7a3e9c15-2b84-4d60-9f17-c5e8a2d4b031",
                                            "web": "https://my.monicahq.com/settings/account/possession-tags"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/possession-tags/{possessionTag}": {
            "get": {
                "operationId": "possession-tags-show",
                "tags": [
                    "Possession tags"
                ],
                "summary": "Get a possession tag",
                "description": "Retrieve one possession tag.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "possessionTag",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession tag. A tag belonging to somebody else answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A possession tag object. A tag belonging to somebody else answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession tag.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_tag. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the tag reads, such as Insured or To sell."
                                                        },
                                                        "colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of the eight vault colours, as a hexadecimal value."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the tag was added, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When its name or colour last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The settings screen where the tags of the account are managed, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_tag",
                                        "id": "7a3e9c15-2b84-4d60-9f17-c5e8a2d4b031",
                                        "attributes": {
                                            "name": "Insured",
                                            "colour": "#2f7f86",
                                            "created_at": 1761436800,
                                            "updated_at": 1761440400
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/possession-tags/7a3e9c15-2b84-4d60-9f17-c5e8a2d4b031",
                                            "web": "https://my.monicahq.com/settings/account/possession-tags"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "possession-tags-show-query",
                "tags": [
                    "Possession tags"
                ],
                "summary": "Get a possession tag",
                "description": "Retrieve one possession tag.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "possessionTag",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession tag. A tag belonging to somebody else answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A possession tag object. A tag belonging to somebody else answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession tag.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_tag. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the tag reads, such as Insured or To sell."
                                                        },
                                                        "colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of the eight vault colours, as a hexadecimal value."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the tag was added, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When its name or colour last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The settings screen where the tags of the account are managed, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_tag",
                                        "id": "7a3e9c15-2b84-4d60-9f17-c5e8a2d4b031",
                                        "attributes": {
                                            "name": "Insured",
                                            "colour": "#2f7f86",
                                            "created_at": 1761436800,
                                            "updated_at": 1761440400
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/possession-tags/7a3e9c15-2b84-4d60-9f17-c5e8a2d4b031",
                                            "web": "https://my.monicahq.com/settings/account/possession-tags"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "put": {
                "operationId": "possession-tags-update",
                "tags": [
                    "Possession tags"
                ],
                "summary": "Change a possession tag",
                "description": "Rename a possession tag or set its colour. Neither can be null.\n\nChanging only the case of its own name is allowed. The change is written to the account log.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "possessionTag",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession tag. A tag belonging to somebody else answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "description": "The new name. Up to 50 characters. Markup and surrounding blank space are stripped, and a name left with nothing in it is refused. A name another tag of the account already has, ignoring case, is refused with “You already have a tag with this name.”"
                                    },
                                    "colour": {
                                        "type": "string",
                                        "description": "One of the vault colours: #3f5fd0, #4f8a49, #9a6a24, #9a3f2b, #6b4fa8, #2f7f86, #a8447a or #4a4a52."
                                    }
                                }
                            },
                            "example": {
                                "name": "Insured",
                                "colour": "#2f7f86"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The possession tag object as it now reads.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession tag.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_tag. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the tag reads, such as Insured or To sell."
                                                        },
                                                        "colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of the eight vault colours, as a hexadecimal value."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the tag was added, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When its name or colour last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The settings screen where the tags of the account are managed, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_tag",
                                        "id": "7a3e9c15-2b84-4d60-9f17-c5e8a2d4b031",
                                        "attributes": {
                                            "name": "Insured",
                                            "colour": "#2f7f86",
                                            "created_at": 1761436800,
                                            "updated_at": 1761440400
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/possession-tags/7a3e9c15-2b84-4d60-9f17-c5e8a2d4b031",
                                            "web": "https://my.monicahq.com/settings/account/possession-tags"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "delete": {
                "operationId": "possession-tags-destroy",
                "tags": [
                    "Possession tags"
                ],
                "summary": "Delete a possession tag",
                "description": "Delete a possession tag.\n\nThe deletion is final. The account log keeps the name of the tag.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "possessionTag",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession tag. A tag belonging to somebody else answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Nothing. A tag belonging to somebody else answers 404."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/possession-conditions": {
            "get": {
                "operationId": "possession-conditions-index",
                "tags": [
                    "Possession conditions"
                ],
                "summary": "List possession conditions",
                "description": "List every possession condition of your account, in the order the account keeps them.\n\nA possession condition belongs to the account, not to a vault. Every account starts with six: New, Like new, Used, Worn, Damaged and Broken, in the language of the person who created it.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to answer with.",
                        "schema": {
                            "type": "integer",
                            "default": 1
                        }
                    },
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "How many conditions one page holds, between 1 and 100. A number outside the range is brought back into it.",
                        "schema": {
                            "type": "integer",
                            "default": 25
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of possession condition objects, and how many there are in all. An account with none answers an empty list.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The possession conditions on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One possession condition.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always possession_condition. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the condition reads, such as New or Broken."
                                                            },
                                                            "colour": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "One of the eight vault colours, as a hexadecimal value."
                                                            },
                                                            "icon": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "One of the glyphs of the catalogue, or null when the condition has none."
                                                            },
                                                            "position": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "Its place in the order the account keeps, from best to worst, counting from 1."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the condition was added, as a count of seconds since 1970."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds, or null."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The settings screen where the conditions of the account are managed, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "possession_condition",
                                            "id": "4c1e7a92-8d35-4f06-b2a9-e3f71c5d8b40",
                                            "attributes": {
                                                "name": "Like new",
                                                "colour": "#2f7f86",
                                                "icon": null,
                                                "position": 2,
                                                "created_at": 1761436800,
                                                "updated_at": 1761440400
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/possession-conditions/4c1e7a92-8d35-4f06-b2a9-e3f71c5d8b40",
                                                "web": "https://my.monicahq.com/settings/account/possession-conditions"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "possession-conditions-index-query",
                "tags": [
                    "Possession conditions"
                ],
                "summary": "List possession conditions",
                "description": "List every possession condition of your account, in the order the account keeps them.\n\nA possession condition belongs to the account, not to a vault. Every account starts with six: New, Like new, Used, Worn, Damaged and Broken, in the language of the person who created it.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "page": {
                                        "type": "integer",
                                        "default": 1,
                                        "description": "Which page to answer with."
                                    },
                                    "per_page": {
                                        "type": "integer",
                                        "default": 25,
                                        "description": "How many conditions one page holds, between 1 and 100. A number outside the range is brought back into it."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "A page of possession condition objects, and how many there are in all. An account with none answers an empty list.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The possession conditions on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One possession condition.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always possession_condition. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the condition reads, such as New or Broken."
                                                            },
                                                            "colour": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "One of the eight vault colours, as a hexadecimal value."
                                                            },
                                                            "icon": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "One of the glyphs of the catalogue, or null when the condition has none."
                                                            },
                                                            "position": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "Its place in the order the account keeps, from best to worst, counting from 1."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the condition was added, as a count of seconds since 1970."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds, or null."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The settings screen where the conditions of the account are managed, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "possession_condition",
                                            "id": "4c1e7a92-8d35-4f06-b2a9-e3f71c5d8b40",
                                            "attributes": {
                                                "name": "Like new",
                                                "colour": "#2f7f86",
                                                "icon": null,
                                                "position": 2,
                                                "created_at": 1761436800,
                                                "updated_at": 1761440400
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/possession-conditions/4c1e7a92-8d35-4f06-b2a9-e3f71c5d8b40",
                                                "web": "https://my.monicahq.com/settings/account/possession-conditions"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "post": {
                "operationId": "possession-conditions-create",
                "tags": [
                    "Possession conditions"
                ],
                "summary": "Add a possession condition",
                "description": "Add a state the possessions of your account can be in. It goes last in the order.\n\nThe change is written to the account log.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "description": "What the condition reads. Up to 50 characters. Markup and surrounding blank space are stripped, and a name left with nothing in it is refused. A name another condition of the account already has, ignoring case, is refused with “You already have a condition with this name.”"
                                    },
                                    "colour": {
                                        "type": "string",
                                        "description": "One of the vault colours: #3f5fd0, #4f8a49, #9a6a24, #9a3f2b, #6b4fa8, #2f7f86, #a8447a or #4a4a52. Blue when left out."
                                    },
                                    "icon": {
                                        "type": "string",
                                        "description": "One of the glyphs of the catalogue: profile, people, note, relationship, family, timeline, calendar, reminder, tasks, memory, journal, file, mail, phone, place, home, briefcase, organization, graduation, health, activity, ball, food, gift, pet, plane, globe, book, music, coin, car, target, tag, heart, star, lock, layers. None when left out."
                                    }
                                },
                                "required": [
                                    "name"
                                ]
                            },
                            "example": {
                                "name": "Mint",
                                "colour": "#2f7f86",
                                "icon": "star"
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The possession condition object that was added.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession condition.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_condition. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the condition reads, such as New or Broken."
                                                        },
                                                        "colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of the eight vault colours, as a hexadecimal value."
                                                        },
                                                        "icon": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of the glyphs of the catalogue, or null when the condition has none."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Its place in the order the account keeps, from best to worst, counting from 1."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the condition was added, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The settings screen where the conditions of the account are managed, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_condition",
                                        "id": "4c1e7a92-8d35-4f06-b2a9-e3f71c5d8b40",
                                        "attributes": {
                                            "name": "Mint",
                                            "colour": "#2f7f86",
                                            "icon": "star",
                                            "position": 7,
                                            "created_at": 1761436800,
                                            "updated_at": 1761436800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/possession-conditions/4c1e7a92-8d35-4f06-b2a9-e3f71c5d8b40",
                                            "web": "https://my.monicahq.com/settings/account/possession-conditions"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/possession-conditions/{possessionCondition}": {
            "get": {
                "operationId": "possession-conditions-show",
                "tags": [
                    "Possession conditions"
                ],
                "summary": "Get a possession condition",
                "description": "Retrieve one possession condition.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "possessionCondition",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession condition. A condition belonging to somebody else answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A possession condition object. A condition belonging to somebody else answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession condition.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_condition. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the condition reads, such as New or Broken."
                                                        },
                                                        "colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of the eight vault colours, as a hexadecimal value."
                                                        },
                                                        "icon": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of the glyphs of the catalogue, or null when the condition has none."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Its place in the order the account keeps, from best to worst, counting from 1."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the condition was added, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The settings screen where the conditions of the account are managed, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_condition",
                                        "id": "4c1e7a92-8d35-4f06-b2a9-e3f71c5d8b40",
                                        "attributes": {
                                            "name": "Like new",
                                            "colour": "#2f7f86",
                                            "icon": null,
                                            "position": 2,
                                            "created_at": 1761436800,
                                            "updated_at": 1761440400
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/possession-conditions/4c1e7a92-8d35-4f06-b2a9-e3f71c5d8b40",
                                            "web": "https://my.monicahq.com/settings/account/possession-conditions"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "possession-conditions-show-query",
                "tags": [
                    "Possession conditions"
                ],
                "summary": "Get a possession condition",
                "description": "Retrieve one possession condition.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "possessionCondition",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession condition. A condition belonging to somebody else answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A possession condition object. A condition belonging to somebody else answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession condition.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_condition. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the condition reads, such as New or Broken."
                                                        },
                                                        "colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of the eight vault colours, as a hexadecimal value."
                                                        },
                                                        "icon": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of the glyphs of the catalogue, or null when the condition has none."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Its place in the order the account keeps, from best to worst, counting from 1."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the condition was added, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The settings screen where the conditions of the account are managed, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_condition",
                                        "id": "4c1e7a92-8d35-4f06-b2a9-e3f71c5d8b40",
                                        "attributes": {
                                            "name": "Like new",
                                            "colour": "#2f7f86",
                                            "icon": null,
                                            "position": 2,
                                            "created_at": 1761436800,
                                            "updated_at": 1761440400
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/possession-conditions/4c1e7a92-8d35-4f06-b2a9-e3f71c5d8b40",
                                            "web": "https://my.monicahq.com/settings/account/possession-conditions"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "put": {
                "operationId": "possession-conditions-update",
                "tags": [
                    "Possession conditions"
                ],
                "summary": "Change a possession condition",
                "description": "Rename a possession condition, or set its colour or its icon. The name and the colour cannot be null; an icon sent as null is removed.\n\nThe condition keeps its place in the order. Changing only the case of its own name is allowed. The change is written to the account log.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "possessionCondition",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession condition. A condition belonging to somebody else answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "description": "The new name. Up to 50 characters. Markup and surrounding blank space are stripped, and a name left with nothing in it is refused. A name another condition of the account already has, ignoring case, is refused with “You already have a condition with this name.”"
                                    },
                                    "colour": {
                                        "type": "string",
                                        "description": "One of the vault colours: #3f5fd0, #4f8a49, #9a6a24, #9a3f2b, #6b4fa8, #2f7f86, #a8447a or #4a4a52."
                                    },
                                    "icon": {
                                        "type": "string",
                                        "description": "One of the glyphs of the catalogue: profile, people, note, relationship, family, timeline, calendar, reminder, tasks, memory, journal, file, mail, phone, place, home, briefcase, organization, graduation, health, activity, ball, food, gift, pet, plane, globe, book, music, coin, car, target, tag, heart, star, lock, layers. Null removes the icon."
                                    }
                                }
                            },
                            "example": {
                                "name": "Well loved",
                                "colour": "#9a6a24",
                                "icon": "heart"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The possession condition object as it now reads.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession condition.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_condition. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the condition reads, such as New or Broken."
                                                        },
                                                        "colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of the eight vault colours, as a hexadecimal value."
                                                        },
                                                        "icon": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of the glyphs of the catalogue, or null when the condition has none."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Its place in the order the account keeps, from best to worst, counting from 1."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the condition was added, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The settings screen where the conditions of the account are managed, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_condition",
                                        "id": "4c1e7a92-8d35-4f06-b2a9-e3f71c5d8b40",
                                        "attributes": {
                                            "name": "Well loved",
                                            "colour": "#9a6a24",
                                            "icon": "heart",
                                            "position": 4,
                                            "created_at": 1761436800,
                                            "updated_at": 1761440400
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/possession-conditions/4c1e7a92-8d35-4f06-b2a9-e3f71c5d8b40",
                                            "web": "https://my.monicahq.com/settings/account/possession-conditions"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "delete": {
                "operationId": "possession-conditions-destroy",
                "tags": [
                    "Possession conditions"
                ],
                "summary": "Delete a possession condition",
                "description": "Delete a possession condition. The ones after it move up to close the gap.\n\nThe deletion is final. The account log keeps the name of the condition.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "possessionCondition",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession condition. A condition belonging to somebody else answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Nothing. A condition belonging to somebody else answers 404."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/possession-conditions/{possessionCondition}/position": {
            "put": {
                "operationId": "possession-conditions-position",
                "tags": [
                    "Possession conditions"
                ],
                "summary": "Move a possession condition",
                "description": "Move a possession condition to another place in the order. The others shift to make room.\n\nA position past the end puts the condition last. The change is written to the account log.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "possessionCondition",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession condition. A condition belonging to somebody else answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "position": {
                                        "type": "integer",
                                        "description": "Where it goes, counting from 1."
                                    }
                                },
                                "required": [
                                    "position"
                                ]
                            },
                            "example": {
                                "position": 1
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The possession condition object at its new place.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession condition.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_condition. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the condition reads, such as New or Broken."
                                                        },
                                                        "colour": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of the eight vault colours, as a hexadecimal value."
                                                        },
                                                        "icon": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One of the glyphs of the catalogue, or null when the condition has none."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Its place in the order the account keeps, from best to worst, counting from 1."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the condition was added, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The settings screen where the conditions of the account are managed, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_condition",
                                        "id": "4c1e7a92-8d35-4f06-b2a9-e3f71c5d8b40",
                                        "attributes": {
                                            "name": "Mint",
                                            "colour": "#2f7f86",
                                            "icon": "star",
                                            "position": 1,
                                            "created_at": 1761436800,
                                            "updated_at": 1761440400
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/possession-conditions/4c1e7a92-8d35-4f06-b2a9-e3f71c5d8b40",
                                            "web": "https://my.monicahq.com/settings/account/possession-conditions"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/possessions/{possession}/transactions": {
            "get": {
                "operationId": "possession-transactions-index",
                "tags": [
                    "Possession transactions"
                ],
                "summary": "List the transactions of a possession",
                "description": "List every transaction of a possession, oldest first.\n\nAn undated transaction counts as the oldest and comes first; two on the same day come in the order they were recorded. The list is whole rather than paginated.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Every transaction object of the possession, or an empty list. A vault or a possession of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "Every one of the possession transactions, whole rather than a page at a time.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One possession transaction.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always possession_transaction. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "type": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What happened: purchase, sale, exchange, gift_received, gift_given, inheritance, refund, fee, tax, shipping or other."
                                                            },
                                                            "changes_ownership": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the possession changed hands, true for the first six types and false for the money only ones."
                                                            },
                                                            "is_acquisition": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether this is the transaction that brought the possession in: its earliest purchase, exchange, gift received or inheritance, undated ones first."
                                                            },
                                                            "occurred_on": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The day it happened, written as 2005-03-14, or null when it is not known."
                                                            },
                                                            "counterparty": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Who was on the other side, as text, or null."
                                                            },
                                                            "amount": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The price or the amount, as a string with two decimals, or null."
                                                            },
                                                            "tax": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The tax paid, or null."
                                                            },
                                                            "fees": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The fees paid, or null."
                                                            },
                                                            "shipping": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The shipping paid, or null."
                                                            },
                                                            "entered_total": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The total typed in, which overrides the sum of the four figures, or null."
                                                            },
                                                            "total": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The total of the transaction: the entered total, else the sum of the figures set, else null."
                                                            },
                                                            "total_source": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Where the total comes from: entered, sum or unknown."
                                                            },
                                                            "currency": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The currency of every figure, in lower case, or null when no figure is set. Nothing is ever converted."
                                                            },
                                                            "reference": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "An invoice, receipt or deed number, or null."
                                                            },
                                                            "source_url": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Where the transaction can be checked, or null."
                                                            },
                                                            "note": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Anything worth remembering about it, or null."
                                                            },
                                                            "documents": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "The invoices, receipts and deeds attached to it, oldest first.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One document.",
                                                                    "properties": {
                                                                        "id": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "format": "uuid",
                                                                            "description": "The id of the file, which is what removing the document takes."
                                                                        },
                                                                        "name": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The name of the file as it was uploaded."
                                                                        },
                                                                        "mime_type": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The kind of the file, such as application/pdf."
                                                                        },
                                                                        "size_in_bytes": {
                                                                            "type": [
                                                                                "integer",
                                                                                "null"
                                                                            ],
                                                                            "description": "How much storage the file takes."
                                                                        }
                                                                    }
                                                                }
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the transaction was recorded, as a count of seconds since 1970."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds, or null."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The Transactions section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "possession_transaction",
                                            "id": "3f8a1c62-7d94-4b2e-a5c0-6e9b2d4f1a83",
                                            "attributes": {
                                                "type": "purchase",
                                                "changes_ownership": true,
                                                "is_acquisition": true,
                                                "occurred_on": "2005-03-14",
                                                "counterparty": "Dundies Inc.",
                                                "amount": "40.00",
                                                "tax": "3.20",
                                                "fees": null,
                                                "shipping": "6.00",
                                                "entered_total": null,
                                                "total": "49.20",
                                                "total_source": "sum",
                                                "currency": "usd",
                                                "reference": "Invoice 4021",
                                                "source_url": null,
                                                "note": "For Kevin, the hottest in the office award.",
                                                "documents": [
                                                    {
                                                        "id": "5c2e8f14-9a63-4d7b-b0e1-3f6a9c4d2e58",
                                                        "name": "Invoice 4021.pdf",
                                                        "mime_type": "application/pdf",
                                                        "size_in_bytes": 88000
                                                    }
                                                ],
                                                "created_at": 1761436800,
                                                "updated_at": 1761436800
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/transactions/3f8a1c62-7d94-4b2e-a5c0-6e9b2d4f1a83",
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/transactions"
                                            }
                                        },
                                        {
                                            "type": "possession_transaction",
                                            "id": "b71d5e09-2c46-4a8f-9e3b-0f5c7a2d6e14",
                                            "attributes": {
                                                "type": "fee",
                                                "changes_ownership": false,
                                                "is_acquisition": false,
                                                "occurred_on": "2006-01-03",
                                                "counterparty": "Chili’s",
                                                "amount": null,
                                                "tax": null,
                                                "fees": "85.00",
                                                "shipping": null,
                                                "entered_total": null,
                                                "total": "85.00",
                                                "total_source": "sum",
                                                "currency": "usd",
                                                "reference": null,
                                                "source_url": null,
                                                "note": null,
                                                "documents": [],
                                                "created_at": 1761440400,
                                                "updated_at": 1761440400
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/transactions/b71d5e09-2c46-4a8f-9e3b-0f5c7a2d6e14",
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/transactions"
                                            }
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "possession-transactions-index-query",
                "tags": [
                    "Possession transactions"
                ],
                "summary": "List the transactions of a possession",
                "description": "List every transaction of a possession, oldest first.\n\nAn undated transaction counts as the oldest and comes first; two on the same day come in the order they were recorded. The list is whole rather than paginated.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Every transaction object of the possession, or an empty list. A vault or a possession of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "Every one of the possession transactions, whole rather than a page at a time.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One possession transaction.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always possession_transaction. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "type": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What happened: purchase, sale, exchange, gift_received, gift_given, inheritance, refund, fee, tax, shipping or other."
                                                            },
                                                            "changes_ownership": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the possession changed hands, true for the first six types and false for the money only ones."
                                                            },
                                                            "is_acquisition": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether this is the transaction that brought the possession in: its earliest purchase, exchange, gift received or inheritance, undated ones first."
                                                            },
                                                            "occurred_on": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The day it happened, written as 2005-03-14, or null when it is not known."
                                                            },
                                                            "counterparty": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Who was on the other side, as text, or null."
                                                            },
                                                            "amount": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The price or the amount, as a string with two decimals, or null."
                                                            },
                                                            "tax": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The tax paid, or null."
                                                            },
                                                            "fees": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The fees paid, or null."
                                                            },
                                                            "shipping": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The shipping paid, or null."
                                                            },
                                                            "entered_total": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The total typed in, which overrides the sum of the four figures, or null."
                                                            },
                                                            "total": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The total of the transaction: the entered total, else the sum of the figures set, else null."
                                                            },
                                                            "total_source": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Where the total comes from: entered, sum or unknown."
                                                            },
                                                            "currency": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The currency of every figure, in lower case, or null when no figure is set. Nothing is ever converted."
                                                            },
                                                            "reference": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "An invoice, receipt or deed number, or null."
                                                            },
                                                            "source_url": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Where the transaction can be checked, or null."
                                                            },
                                                            "note": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Anything worth remembering about it, or null."
                                                            },
                                                            "documents": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "The invoices, receipts and deeds attached to it, oldest first.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One document.",
                                                                    "properties": {
                                                                        "id": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "format": "uuid",
                                                                            "description": "The id of the file, which is what removing the document takes."
                                                                        },
                                                                        "name": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The name of the file as it was uploaded."
                                                                        },
                                                                        "mime_type": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The kind of the file, such as application/pdf."
                                                                        },
                                                                        "size_in_bytes": {
                                                                            "type": [
                                                                                "integer",
                                                                                "null"
                                                                            ],
                                                                            "description": "How much storage the file takes."
                                                                        }
                                                                    }
                                                                }
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the transaction was recorded, as a count of seconds since 1970."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds, or null."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The Transactions section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "possession_transaction",
                                            "id": "3f8a1c62-7d94-4b2e-a5c0-6e9b2d4f1a83",
                                            "attributes": {
                                                "type": "purchase",
                                                "changes_ownership": true,
                                                "is_acquisition": true,
                                                "occurred_on": "2005-03-14",
                                                "counterparty": "Dundies Inc.",
                                                "amount": "40.00",
                                                "tax": "3.20",
                                                "fees": null,
                                                "shipping": "6.00",
                                                "entered_total": null,
                                                "total": "49.20",
                                                "total_source": "sum",
                                                "currency": "usd",
                                                "reference": "Invoice 4021",
                                                "source_url": null,
                                                "note": "For Kevin, the hottest in the office award.",
                                                "documents": [
                                                    {
                                                        "id": "5c2e8f14-9a63-4d7b-b0e1-3f6a9c4d2e58",
                                                        "name": "Invoice 4021.pdf",
                                                        "mime_type": "application/pdf",
                                                        "size_in_bytes": 88000
                                                    }
                                                ],
                                                "created_at": 1761436800,
                                                "updated_at": 1761436800
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/transactions/3f8a1c62-7d94-4b2e-a5c0-6e9b2d4f1a83",
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/transactions"
                                            }
                                        },
                                        {
                                            "type": "possession_transaction",
                                            "id": "b71d5e09-2c46-4a8f-9e3b-0f5c7a2d6e14",
                                            "attributes": {
                                                "type": "fee",
                                                "changes_ownership": false,
                                                "is_acquisition": false,
                                                "occurred_on": "2006-01-03",
                                                "counterparty": "Chili’s",
                                                "amount": null,
                                                "tax": null,
                                                "fees": "85.00",
                                                "shipping": null,
                                                "entered_total": null,
                                                "total": "85.00",
                                                "total_source": "sum",
                                                "currency": "usd",
                                                "reference": null,
                                                "source_url": null,
                                                "note": null,
                                                "documents": [],
                                                "created_at": 1761440400,
                                                "updated_at": 1761440400
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/transactions/b71d5e09-2c46-4a8f-9e3b-0f5c7a2d6e14",
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/transactions"
                                            }
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "post": {
                "operationId": "possession-transactions-create",
                "tags": [
                    "Possession transactions"
                ],
                "summary": "Record a transaction",
                "description": "Record money or ownership changing hands for a possession.\n\nOnly the type is required. The earliest purchase, exchange, gift received or inheritance becomes the acquisition of the possession, so recording an earlier one moves it.\n\nThe change is written to the account log.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "type": {
                                        "type": "string",
                                        "description": "What happened: purchase, sale, exchange, gift_received, gift_given, inheritance, refund, fee, tax, shipping or other."
                                    },
                                    "occurred_on": {
                                        "type": "string",
                                        "description": "The day it happened, written as 2005-03-14. Left out when it is not known."
                                    },
                                    "counterparty": {
                                        "type": "string",
                                        "description": "Who was on the other side, as text, up to 255 characters. Markup is stripped."
                                    },
                                    "amount": {
                                        "type": "string",
                                        "description": "The price or the amount. Zero or more, up to 9999999999.99. A figure below zero is refused with “Write an amount of zero or more.”"
                                    },
                                    "tax": {
                                        "type": "string",
                                        "description": "The tax paid. Zero or more, up to 9999999999.99. A figure below zero is refused with “Write an amount of zero or more.”"
                                    },
                                    "fees": {
                                        "type": "string",
                                        "description": "The fees paid. Zero or more, up to 9999999999.99. A figure below zero is refused with “Write an amount of zero or more.”"
                                    },
                                    "shipping": {
                                        "type": "string",
                                        "description": "The shipping paid. Zero or more, up to 9999999999.99. A figure below zero is refused with “Write an amount of zero or more.”"
                                    },
                                    "entered_total": {
                                        "type": "string",
                                        "description": "The total, when it is not the sum of the four figures. Zero or more, up to 9999999999.99. A figure below zero is refused with “Write an amount of zero or more.”"
                                    },
                                    "currency": {
                                        "type": "string",
                                        "description": "The currency of every figure: usd, eur, gbp, cad, aud, chf, jpy, brl, inr or cny. Required once a figure is set, else refused with “Choose the currency of these amounts.”"
                                    },
                                    "reference": {
                                        "type": "string",
                                        "description": "An invoice, receipt or deed number, up to 255 characters."
                                    },
                                    "source_url": {
                                        "type": "string",
                                        "description": "A full web address where the transaction can be checked, up to 2,048 characters."
                                    },
                                    "note": {
                                        "type": "string",
                                        "description": "Anything worth remembering about it, up to 5,000 characters."
                                    }
                                },
                                "required": [
                                    "type"
                                ]
                            },
                            "example": {
                                "type": "purchase",
                                "occurred_on": "2005-03-14",
                                "counterparty": "Dundies Inc.",
                                "amount": 40,
                                "tax": 3.2,
                                "shipping": 6,
                                "currency": "usd",
                                "reference": "Invoice 4021",
                                "note": "For Kevin, the hottest in the office award."
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The transaction object that was recorded.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession transaction.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_transaction. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "type": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What happened: purchase, sale, exchange, gift_received, gift_given, inheritance, refund, fee, tax, shipping or other."
                                                        },
                                                        "changes_ownership": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the possession changed hands, true for the first six types and false for the money only ones."
                                                        },
                                                        "is_acquisition": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether this is the transaction that brought the possession in: its earliest purchase, exchange, gift received or inheritance, undated ones first."
                                                        },
                                                        "occurred_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day it happened, written as 2005-03-14, or null when it is not known."
                                                        },
                                                        "counterparty": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Who was on the other side, as text, or null."
                                                        },
                                                        "amount": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The price or the amount, as a string with two decimals, or null."
                                                        },
                                                        "tax": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The tax paid, or null."
                                                        },
                                                        "fees": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The fees paid, or null."
                                                        },
                                                        "shipping": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The shipping paid, or null."
                                                        },
                                                        "entered_total": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The total typed in, which overrides the sum of the four figures, or null."
                                                        },
                                                        "total": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The total of the transaction: the entered total, else the sum of the figures set, else null."
                                                        },
                                                        "total_source": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the total comes from: entered, sum or unknown."
                                                        },
                                                        "currency": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The currency of every figure, in lower case, or null when no figure is set. Nothing is ever converted."
                                                        },
                                                        "reference": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "An invoice, receipt or deed number, or null."
                                                        },
                                                        "source_url": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the transaction can be checked, or null."
                                                        },
                                                        "note": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Anything worth remembering about it, or null."
                                                        },
                                                        "documents": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The invoices, receipts and deeds attached to it, oldest first."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the transaction was recorded, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The Transactions section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_transaction",
                                        "id": "3f8a1c62-7d94-4b2e-a5c0-6e9b2d4f1a83",
                                        "attributes": {
                                            "type": "purchase",
                                            "changes_ownership": true,
                                            "is_acquisition": true,
                                            "occurred_on": "2005-03-14",
                                            "counterparty": "Dundies Inc.",
                                            "amount": "40.00",
                                            "tax": "3.20",
                                            "fees": null,
                                            "shipping": "6.00",
                                            "entered_total": null,
                                            "total": "49.20",
                                            "total_source": "sum",
                                            "currency": "usd",
                                            "reference": "Invoice 4021",
                                            "source_url": null,
                                            "note": "For Kevin, the hottest in the office award.",
                                            "documents": [],
                                            "created_at": 1761436800,
                                            "updated_at": 1761436800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/transactions/3f8a1c62-7d94-4b2e-a5c0-6e9b2d4f1a83",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/transactions"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/possessions/{possession}/transactions/{transaction}": {
            "get": {
                "operationId": "possession-transactions-show",
                "tags": [
                    "Possession transactions"
                ],
                "summary": "Get a transaction",
                "description": "Retrieve one transaction of a possession.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "transaction",
                        "in": "path",
                        "required": true,
                        "description": "The id of the transaction. A transaction of another possession answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A transaction object. A vault, a possession or a transaction of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession transaction.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_transaction. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "type": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What happened: purchase, sale, exchange, gift_received, gift_given, inheritance, refund, fee, tax, shipping or other."
                                                        },
                                                        "changes_ownership": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the possession changed hands, true for the first six types and false for the money only ones."
                                                        },
                                                        "is_acquisition": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether this is the transaction that brought the possession in: its earliest purchase, exchange, gift received or inheritance, undated ones first."
                                                        },
                                                        "occurred_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day it happened, written as 2005-03-14, or null when it is not known."
                                                        },
                                                        "counterparty": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Who was on the other side, as text, or null."
                                                        },
                                                        "amount": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The price or the amount, as a string with two decimals, or null."
                                                        },
                                                        "tax": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The tax paid, or null."
                                                        },
                                                        "fees": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The fees paid, or null."
                                                        },
                                                        "shipping": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The shipping paid, or null."
                                                        },
                                                        "entered_total": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The total typed in, which overrides the sum of the four figures, or null."
                                                        },
                                                        "total": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The total of the transaction: the entered total, else the sum of the figures set, else null."
                                                        },
                                                        "total_source": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the total comes from: entered, sum or unknown."
                                                        },
                                                        "currency": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The currency of every figure, in lower case, or null when no figure is set. Nothing is ever converted."
                                                        },
                                                        "reference": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "An invoice, receipt or deed number, or null."
                                                        },
                                                        "source_url": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the transaction can be checked, or null."
                                                        },
                                                        "note": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Anything worth remembering about it, or null."
                                                        },
                                                        "documents": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The invoices, receipts and deeds attached to it, oldest first.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One document.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the file, which is what removing the document takes."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name of the file as it was uploaded."
                                                                    },
                                                                    "mime_type": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The kind of the file, such as application/pdf."
                                                                    },
                                                                    "size_in_bytes": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "How much storage the file takes."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the transaction was recorded, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The Transactions section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_transaction",
                                        "id": "3f8a1c62-7d94-4b2e-a5c0-6e9b2d4f1a83",
                                        "attributes": {
                                            "type": "purchase",
                                            "changes_ownership": true,
                                            "is_acquisition": true,
                                            "occurred_on": "2005-03-14",
                                            "counterparty": "Dundies Inc.",
                                            "amount": "40.00",
                                            "tax": "3.20",
                                            "fees": null,
                                            "shipping": "6.00",
                                            "entered_total": null,
                                            "total": "49.20",
                                            "total_source": "sum",
                                            "currency": "usd",
                                            "reference": "Invoice 4021",
                                            "source_url": null,
                                            "note": "For Kevin, the hottest in the office award.",
                                            "documents": [
                                                {
                                                    "id": "5c2e8f14-9a63-4d7b-b0e1-3f6a9c4d2e58",
                                                    "name": "Invoice 4021.pdf",
                                                    "mime_type": "application/pdf",
                                                    "size_in_bytes": 88000
                                                }
                                            ],
                                            "created_at": 1761436800,
                                            "updated_at": 1761436800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/transactions/3f8a1c62-7d94-4b2e-a5c0-6e9b2d4f1a83",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/transactions"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "possession-transactions-show-query",
                "tags": [
                    "Possession transactions"
                ],
                "summary": "Get a transaction",
                "description": "Retrieve one transaction of a possession.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "transaction",
                        "in": "path",
                        "required": true,
                        "description": "The id of the transaction. A transaction of another possession answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A transaction object. A vault, a possession or a transaction of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession transaction.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_transaction. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "type": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What happened: purchase, sale, exchange, gift_received, gift_given, inheritance, refund, fee, tax, shipping or other."
                                                        },
                                                        "changes_ownership": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the possession changed hands, true for the first six types and false for the money only ones."
                                                        },
                                                        "is_acquisition": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether this is the transaction that brought the possession in: its earliest purchase, exchange, gift received or inheritance, undated ones first."
                                                        },
                                                        "occurred_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day it happened, written as 2005-03-14, or null when it is not known."
                                                        },
                                                        "counterparty": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Who was on the other side, as text, or null."
                                                        },
                                                        "amount": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The price or the amount, as a string with two decimals, or null."
                                                        },
                                                        "tax": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The tax paid, or null."
                                                        },
                                                        "fees": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The fees paid, or null."
                                                        },
                                                        "shipping": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The shipping paid, or null."
                                                        },
                                                        "entered_total": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The total typed in, which overrides the sum of the four figures, or null."
                                                        },
                                                        "total": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The total of the transaction: the entered total, else the sum of the figures set, else null."
                                                        },
                                                        "total_source": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the total comes from: entered, sum or unknown."
                                                        },
                                                        "currency": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The currency of every figure, in lower case, or null when no figure is set. Nothing is ever converted."
                                                        },
                                                        "reference": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "An invoice, receipt or deed number, or null."
                                                        },
                                                        "source_url": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the transaction can be checked, or null."
                                                        },
                                                        "note": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Anything worth remembering about it, or null."
                                                        },
                                                        "documents": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The invoices, receipts and deeds attached to it, oldest first.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One document.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the file, which is what removing the document takes."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name of the file as it was uploaded."
                                                                    },
                                                                    "mime_type": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The kind of the file, such as application/pdf."
                                                                    },
                                                                    "size_in_bytes": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "How much storage the file takes."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the transaction was recorded, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The Transactions section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_transaction",
                                        "id": "3f8a1c62-7d94-4b2e-a5c0-6e9b2d4f1a83",
                                        "attributes": {
                                            "type": "purchase",
                                            "changes_ownership": true,
                                            "is_acquisition": true,
                                            "occurred_on": "2005-03-14",
                                            "counterparty": "Dundies Inc.",
                                            "amount": "40.00",
                                            "tax": "3.20",
                                            "fees": null,
                                            "shipping": "6.00",
                                            "entered_total": null,
                                            "total": "49.20",
                                            "total_source": "sum",
                                            "currency": "usd",
                                            "reference": "Invoice 4021",
                                            "source_url": null,
                                            "note": "For Kevin, the hottest in the office award.",
                                            "documents": [
                                                {
                                                    "id": "5c2e8f14-9a63-4d7b-b0e1-3f6a9c4d2e58",
                                                    "name": "Invoice 4021.pdf",
                                                    "mime_type": "application/pdf",
                                                    "size_in_bytes": 88000
                                                }
                                            ],
                                            "created_at": 1761436800,
                                            "updated_at": 1761436800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/transactions/3f8a1c62-7d94-4b2e-a5c0-6e9b2d4f1a83",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/transactions"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "put": {
                "operationId": "possession-transactions-update",
                "tags": [
                    "Possession transactions"
                ],
                "summary": "Change a transaction",
                "description": "Change what a transaction says, under the rules that recorded it.\n\nA field left out of the request keeps its value, and a field sent as null is cleared. The acquisition date and price of the possession follow, since they are read from its transactions.\n\nThe change is written to the account log.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "transaction",
                        "in": "path",
                        "required": true,
                        "description": "The id of the transaction. A transaction of another possession answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "type": {
                                        "type": "string",
                                        "description": "What happened, one of the eleven types."
                                    },
                                    "occurred_on": {
                                        "type": "string",
                                        "description": "The day it happened, written as 2005-03-14, or null when it is not known."
                                    },
                                    "counterparty": {
                                        "type": "string",
                                        "description": "Who was on the other side, as text, up to 255 characters."
                                    },
                                    "amount": {
                                        "type": "string",
                                        "description": "The price or the amount. Zero or more, up to 9999999999.99. A figure below zero is refused with “Write an amount of zero or more.”"
                                    },
                                    "tax": {
                                        "type": "string",
                                        "description": "The tax paid. Zero or more, up to 9999999999.99. A figure below zero is refused with “Write an amount of zero or more.”"
                                    },
                                    "fees": {
                                        "type": "string",
                                        "description": "The fees paid. Zero or more, up to 9999999999.99. A figure below zero is refused with “Write an amount of zero or more.”"
                                    },
                                    "shipping": {
                                        "type": "string",
                                        "description": "The shipping paid. Zero or more, up to 9999999999.99. A figure below zero is refused with “Write an amount of zero or more.”"
                                    },
                                    "entered_total": {
                                        "type": "string",
                                        "description": "The total, when it is not the sum of the four figures. Zero or more, up to 9999999999.99. A figure below zero is refused with “Write an amount of zero or more.”"
                                    },
                                    "currency": {
                                        "type": "string",
                                        "description": "The currency of every figure. Required once a figure is set, else refused with “Choose the currency of these amounts.”"
                                    },
                                    "reference": {
                                        "type": "string",
                                        "description": "An invoice, receipt or deed number, up to 255 characters."
                                    },
                                    "source_url": {
                                        "type": "string",
                                        "description": "A full web address where the transaction can be checked."
                                    },
                                    "note": {
                                        "type": "string",
                                        "description": "Anything worth remembering about it."
                                    }
                                }
                            },
                            "example": {
                                "shipping": 6
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The transaction object as it now reads. A transaction of another possession or of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession transaction.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_transaction. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "type": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What happened: purchase, sale, exchange, gift_received, gift_given, inheritance, refund, fee, tax, shipping or other."
                                                        },
                                                        "changes_ownership": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the possession changed hands, true for the first six types and false for the money only ones."
                                                        },
                                                        "is_acquisition": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether this is the transaction that brought the possession in: its earliest purchase, exchange, gift received or inheritance, undated ones first."
                                                        },
                                                        "occurred_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day it happened, written as 2005-03-14, or null when it is not known."
                                                        },
                                                        "counterparty": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Who was on the other side, as text, or null."
                                                        },
                                                        "amount": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The price or the amount, as a string with two decimals, or null."
                                                        },
                                                        "tax": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The tax paid, or null."
                                                        },
                                                        "fees": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The fees paid, or null."
                                                        },
                                                        "shipping": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The shipping paid, or null."
                                                        },
                                                        "entered_total": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The total typed in, which overrides the sum of the four figures, or null."
                                                        },
                                                        "total": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The total of the transaction: the entered total, else the sum of the figures set, else null."
                                                        },
                                                        "total_source": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the total comes from: entered, sum or unknown."
                                                        },
                                                        "currency": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The currency of every figure, in lower case, or null when no figure is set. Nothing is ever converted."
                                                        },
                                                        "reference": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "An invoice, receipt or deed number, or null."
                                                        },
                                                        "source_url": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the transaction can be checked, or null."
                                                        },
                                                        "note": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Anything worth remembering about it, or null."
                                                        },
                                                        "documents": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The invoices, receipts and deeds attached to it, oldest first.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One document.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the file, which is what removing the document takes."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name of the file as it was uploaded."
                                                                    },
                                                                    "mime_type": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The kind of the file, such as application/pdf."
                                                                    },
                                                                    "size_in_bytes": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "How much storage the file takes."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the transaction was recorded, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The Transactions section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_transaction",
                                        "id": "3f8a1c62-7d94-4b2e-a5c0-6e9b2d4f1a83",
                                        "attributes": {
                                            "type": "purchase",
                                            "changes_ownership": true,
                                            "is_acquisition": true,
                                            "occurred_on": "2005-03-14",
                                            "counterparty": "Dundies Inc.",
                                            "amount": "40.00",
                                            "tax": "3.20",
                                            "fees": null,
                                            "shipping": "6.00",
                                            "entered_total": null,
                                            "total": "49.20",
                                            "total_source": "sum",
                                            "currency": "usd",
                                            "reference": "Invoice 4021",
                                            "source_url": null,
                                            "note": "For Kevin, the hottest in the office award.",
                                            "documents": [
                                                {
                                                    "id": "5c2e8f14-9a63-4d7b-b0e1-3f6a9c4d2e58",
                                                    "name": "Invoice 4021.pdf",
                                                    "mime_type": "application/pdf",
                                                    "size_in_bytes": 88000
                                                }
                                            ],
                                            "created_at": 1761436800,
                                            "updated_at": 1761436800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/transactions/3f8a1c62-7d94-4b2e-a5c0-6e9b2d4f1a83",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/transactions"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "delete": {
                "operationId": "possession-transactions-destroy",
                "tags": [
                    "Possession transactions"
                ],
                "summary": "Delete a transaction",
                "description": "Delete a transaction of a possession, with the documents attached to it.\n\nThe deletion is final. When it was the acquisition, the next earliest purchase, exchange, gift received or inheritance becomes the acquisition. The account log keeps the name of the possession.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "transaction",
                        "in": "path",
                        "required": true,
                        "description": "The id of the transaction. A transaction of another possession answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Nothing. A transaction of another possession or of another account answers 404."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/possessions/{possession}/transactions/{transaction}/documents/{file}": {
            "delete": {
                "operationId": "possession-transaction-documents-destroy",
                "tags": [
                    "Possession transactions"
                ],
                "summary": "Remove a document from a transaction",
                "description": "Remove a document from a transaction. The change is written to the account log.\n\nThe file is let go rather than deleted outright. It stays wherever else it is used, and is swept up after a grace period once nothing uses it.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "transaction",
                        "in": "path",
                        "required": true,
                        "description": "The id of the transaction. A transaction of another possession answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "file",
                        "in": "path",
                        "required": true,
                        "description": "The id of the document, as the documents of the transaction give it. A document of another transaction answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Nothing. A transaction of another possession, a document of another transaction or of another account answers 404."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/possessions/{possession}/insurance-records": {
            "get": {
                "operationId": "possession-insurance-records-index",
                "tags": [
                    "Possession insurance records"
                ],
                "summary": "List the insurance records of a possession",
                "description": "List every insurance record of a possession, active first.\n\nActive records come first, then pending, expired and cancelled ones. Within each status the latest start comes first, an undated record after the dated ones. The list is whole rather than paginated.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Every insurance record object of the possession, or an empty list. A vault or a possession of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "Every one of the possession insurance records, whole rather than a page at a time.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One possession insurance record.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always possession_insurance_record. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "insurer": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Who insures the possession, as text."
                                                            },
                                                            "status": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Where the policy stands: active, pending, expired or cancelled. It is the one entered and never follows the dates."
                                                            },
                                                            "is_current": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether this is the record the possession is insured under now: the active one with the latest start."
                                                            },
                                                            "policy_number": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The number of the policy, or null."
                                                            },
                                                            "coverage": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the policy covers, or null."
                                                            },
                                                            "insured_value": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The value the possession is insured for, as a string with two decimals."
                                                            },
                                                            "excess": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What is paid before the insurer pays, or null when it is not recorded."
                                                            },
                                                            "currency": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The currency of the insured value and the excess, in lower case. Nothing is ever converted."
                                                            },
                                                            "starts_on": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The day the policy period starts, written as 2026-01-01, or null."
                                                            },
                                                            "ends_on": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The day the policy period ends or renews, or null for a policy with no end date."
                                                            },
                                                            "is_listed_individually": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the policy names this possession, rather than covering it under the general contents of the home."
                                                            },
                                                            "contact_name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Who to call at the insurer, or null."
                                                            },
                                                            "contact_email": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The email of that person, or null."
                                                            },
                                                            "contact_phone": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The phone of that person, or null."
                                                            },
                                                            "note": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Conditions, exclusions, what the insurer asked for, or null."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the record was added, as a count of seconds since 1970."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds, or null."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The Insurance section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "possession_insurance_record",
                                            "id": "5a2e8c14-6b3f-4d71-9e08-c7f1a3b5d2e6",
                                            "attributes": {
                                                "insurer": "Sabre Insurance",
                                                "status": "active",
                                                "is_current": true,
                                                "policy_number": "SAB-2026-0042",
                                                "coverage": "Theft, fire and accidental damage",
                                                "insured_value": "500.00",
                                                "excess": "50.00",
                                                "currency": "usd",
                                                "starts_on": "2026-01-01",
                                                "ends_on": "2027-01-01",
                                                "is_listed_individually": true,
                                                "contact_name": "Gabe Lewis",
                                                "contact_email": "gabe@sabre.example.com",
                                                "contact_phone": null,
                                                "note": "Not covered when Michael lends it to Dwight.",
                                                "created_at": 1761436800,
                                                "updated_at": 1761436800
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/insurance-records/5a2e8c14-6b3f-4d71-9e08-c7f1a3b5d2e6",
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/insurance"
                                            }
                                        },
                                        {
                                            "type": "possession_insurance_record",
                                            "id": "e09b4d27-3c58-4a1f-8b62-1d7e5f9a0c34",
                                            "attributes": {
                                                "insurer": "Utica Assurance",
                                                "status": "expired",
                                                "is_current": false,
                                                "policy_number": null,
                                                "coverage": "Office contents",
                                                "insured_value": "300.00",
                                                "excess": null,
                                                "currency": "usd",
                                                "starts_on": "2019-11-05",
                                                "ends_on": "2025-12-31",
                                                "is_listed_individually": false,
                                                "contact_name": null,
                                                "contact_email": null,
                                                "contact_phone": null,
                                                "note": null,
                                                "created_at": 1761440400,
                                                "updated_at": 1761440400
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/insurance-records/e09b4d27-3c58-4a1f-8b62-1d7e5f9a0c34",
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/insurance"
                                            }
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "possession-insurance-records-index-query",
                "tags": [
                    "Possession insurance records"
                ],
                "summary": "List the insurance records of a possession",
                "description": "List every insurance record of a possession, active first.\n\nActive records come first, then pending, expired and cancelled ones. Within each status the latest start comes first, an undated record after the dated ones. The list is whole rather than paginated.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Every insurance record object of the possession, or an empty list. A vault or a possession of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "Every one of the possession insurance records, whole rather than a page at a time.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One possession insurance record.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always possession_insurance_record. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "insurer": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Who insures the possession, as text."
                                                            },
                                                            "status": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Where the policy stands: active, pending, expired or cancelled. It is the one entered and never follows the dates."
                                                            },
                                                            "is_current": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether this is the record the possession is insured under now: the active one with the latest start."
                                                            },
                                                            "policy_number": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The number of the policy, or null."
                                                            },
                                                            "coverage": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the policy covers, or null."
                                                            },
                                                            "insured_value": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The value the possession is insured for, as a string with two decimals."
                                                            },
                                                            "excess": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What is paid before the insurer pays, or null when it is not recorded."
                                                            },
                                                            "currency": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The currency of the insured value and the excess, in lower case. Nothing is ever converted."
                                                            },
                                                            "starts_on": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The day the policy period starts, written as 2026-01-01, or null."
                                                            },
                                                            "ends_on": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The day the policy period ends or renews, or null for a policy with no end date."
                                                            },
                                                            "is_listed_individually": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the policy names this possession, rather than covering it under the general contents of the home."
                                                            },
                                                            "contact_name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Who to call at the insurer, or null."
                                                            },
                                                            "contact_email": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The email of that person, or null."
                                                            },
                                                            "contact_phone": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The phone of that person, or null."
                                                            },
                                                            "note": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Conditions, exclusions, what the insurer asked for, or null."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the record was added, as a count of seconds since 1970."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds, or null."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The Insurance section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "possession_insurance_record",
                                            "id": "5a2e8c14-6b3f-4d71-9e08-c7f1a3b5d2e6",
                                            "attributes": {
                                                "insurer": "Sabre Insurance",
                                                "status": "active",
                                                "is_current": true,
                                                "policy_number": "SAB-2026-0042",
                                                "coverage": "Theft, fire and accidental damage",
                                                "insured_value": "500.00",
                                                "excess": "50.00",
                                                "currency": "usd",
                                                "starts_on": "2026-01-01",
                                                "ends_on": "2027-01-01",
                                                "is_listed_individually": true,
                                                "contact_name": "Gabe Lewis",
                                                "contact_email": "gabe@sabre.example.com",
                                                "contact_phone": null,
                                                "note": "Not covered when Michael lends it to Dwight.",
                                                "created_at": 1761436800,
                                                "updated_at": 1761436800
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/insurance-records/5a2e8c14-6b3f-4d71-9e08-c7f1a3b5d2e6",
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/insurance"
                                            }
                                        },
                                        {
                                            "type": "possession_insurance_record",
                                            "id": "e09b4d27-3c58-4a1f-8b62-1d7e5f9a0c34",
                                            "attributes": {
                                                "insurer": "Utica Assurance",
                                                "status": "expired",
                                                "is_current": false,
                                                "policy_number": null,
                                                "coverage": "Office contents",
                                                "insured_value": "300.00",
                                                "excess": null,
                                                "currency": "usd",
                                                "starts_on": "2019-11-05",
                                                "ends_on": "2025-12-31",
                                                "is_listed_individually": false,
                                                "contact_name": null,
                                                "contact_email": null,
                                                "contact_phone": null,
                                                "note": null,
                                                "created_at": 1761440400,
                                                "updated_at": 1761440400
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/insurance-records/e09b4d27-3c58-4a1f-8b62-1d7e5f9a0c34",
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/insurance"
                                            }
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "post": {
                "operationId": "possession-insurance-records-create",
                "tags": [
                    "Possession insurance records"
                ],
                "summary": "Add an insurance record",
                "description": "Record one policy period covering a possession.\n\nThe insurer, the status, the insured value and its currency are required.\n\nThe change is written to the account log.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "insurer": {
                                        "type": "string",
                                        "description": "Who insures the possession, up to 255 characters. Markup is stripped."
                                    },
                                    "status": {
                                        "type": "string",
                                        "description": "Where the policy stands: active, pending, expired or cancelled."
                                    },
                                    "insured_value": {
                                        "type": "string",
                                        "description": "The value the possession is insured for. Zero or more, up to 9999999999.99. A figure below zero is refused with “Write an amount of zero or more.”"
                                    },
                                    "currency": {
                                        "type": "string",
                                        "description": "The currency of the insured value and the excess: usd, eur, gbp, cad, aud, chf, jpy, brl, inr or cny."
                                    },
                                    "policy_number": {
                                        "type": "string",
                                        "description": "The number of the policy, up to 255 characters."
                                    },
                                    "coverage": {
                                        "type": "string",
                                        "description": "What the policy covers, up to 255 characters."
                                    },
                                    "excess": {
                                        "type": "string",
                                        "description": "What is paid before the insurer pays. Zero or more, up to 9999999999.99. A figure below zero is refused with “Write an amount of zero or more.”"
                                    },
                                    "starts_on": {
                                        "type": "string",
                                        "description": "The day the policy period starts, written as 2026-01-01."
                                    },
                                    "ends_on": {
                                        "type": "string",
                                        "description": "The day the policy period ends or renews, written as 2027-01-01. A day before the start is refused with “The end cannot come before the start.”"
                                    },
                                    "is_listed_individually": {
                                        "type": "boolean",
                                        "description": "Whether the policy names this possession rather than the general contents of the home. False when left out on creation."
                                    },
                                    "contact_name": {
                                        "type": "string",
                                        "description": "Who to call at the insurer, up to 255 characters."
                                    },
                                    "contact_email": {
                                        "type": "string",
                                        "description": "The email of that person, a full email address."
                                    },
                                    "contact_phone": {
                                        "type": "string",
                                        "description": "The phone of that person, up to 50 characters."
                                    },
                                    "note": {
                                        "type": "string",
                                        "description": "Conditions, exclusions, what the insurer asked for, up to 5,000 characters."
                                    }
                                },
                                "required": [
                                    "insurer",
                                    "status",
                                    "insured_value",
                                    "currency"
                                ]
                            },
                            "example": {
                                "insurer": "Sabre Insurance",
                                "status": "active",
                                "insured_value": 500,
                                "currency": "usd",
                                "policy_number": "SAB-2026-0042",
                                "coverage": "Theft, fire and accidental damage",
                                "excess": 50,
                                "starts_on": "2026-01-01",
                                "ends_on": "2027-01-01",
                                "is_listed_individually": true,
                                "contact_name": "Gabe Lewis",
                                "contact_email": "gabe@sabre.example.com",
                                "note": "Not covered when Michael lends it to Dwight."
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The insurance record object that was added.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession insurance record.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_insurance_record. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "insurer": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Who insures the possession, as text."
                                                        },
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the policy stands: active, pending, expired or cancelled. It is the one entered and never follows the dates."
                                                        },
                                                        "is_current": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether this is the record the possession is insured under now: the active one with the latest start."
                                                        },
                                                        "policy_number": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The number of the policy, or null."
                                                        },
                                                        "coverage": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the policy covers, or null."
                                                        },
                                                        "insured_value": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The value the possession is insured for, as a string with two decimals."
                                                        },
                                                        "excess": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What is paid before the insurer pays, or null when it is not recorded."
                                                        },
                                                        "currency": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The currency of the insured value and the excess, in lower case. Nothing is ever converted."
                                                        },
                                                        "starts_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day the policy period starts, written as 2026-01-01, or null."
                                                        },
                                                        "ends_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day the policy period ends or renews, or null for a policy with no end date."
                                                        },
                                                        "is_listed_individually": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the policy names this possession, rather than covering it under the general contents of the home."
                                                        },
                                                        "contact_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Who to call at the insurer, or null."
                                                        },
                                                        "contact_email": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The email of that person, or null."
                                                        },
                                                        "contact_phone": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The phone of that person, or null."
                                                        },
                                                        "note": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Conditions, exclusions, what the insurer asked for, or null."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the record was added, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The Insurance section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_insurance_record",
                                        "id": "5a2e8c14-6b3f-4d71-9e08-c7f1a3b5d2e6",
                                        "attributes": {
                                            "insurer": "Sabre Insurance",
                                            "status": "active",
                                            "is_current": true,
                                            "policy_number": "SAB-2026-0042",
                                            "coverage": "Theft, fire and accidental damage",
                                            "insured_value": "500.00",
                                            "excess": "50.00",
                                            "currency": "usd",
                                            "starts_on": "2026-01-01",
                                            "ends_on": "2027-01-01",
                                            "is_listed_individually": true,
                                            "contact_name": "Gabe Lewis",
                                            "contact_email": "gabe@sabre.example.com",
                                            "contact_phone": null,
                                            "note": "Not covered when Michael lends it to Dwight.",
                                            "created_at": 1761436800,
                                            "updated_at": 1761436800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/insurance-records/5a2e8c14-6b3f-4d71-9e08-c7f1a3b5d2e6",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/insurance"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/possessions/{possession}/insurance-records/{insuranceRecord}": {
            "get": {
                "operationId": "possession-insurance-records-show",
                "tags": [
                    "Possession insurance records"
                ],
                "summary": "Get an insurance record",
                "description": "Retrieve one insurance record of a possession.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "insuranceRecord",
                        "in": "path",
                        "required": true,
                        "description": "The id of the insurance record. A record of another possession answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "An insurance record object. A vault, a possession or a record of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession insurance record.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_insurance_record. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "insurer": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Who insures the possession, as text."
                                                        },
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the policy stands: active, pending, expired or cancelled. It is the one entered and never follows the dates."
                                                        },
                                                        "is_current": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether this is the record the possession is insured under now: the active one with the latest start."
                                                        },
                                                        "policy_number": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The number of the policy, or null."
                                                        },
                                                        "coverage": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the policy covers, or null."
                                                        },
                                                        "insured_value": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The value the possession is insured for, as a string with two decimals."
                                                        },
                                                        "excess": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What is paid before the insurer pays, or null when it is not recorded."
                                                        },
                                                        "currency": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The currency of the insured value and the excess, in lower case. Nothing is ever converted."
                                                        },
                                                        "starts_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day the policy period starts, written as 2026-01-01, or null."
                                                        },
                                                        "ends_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day the policy period ends or renews, or null for a policy with no end date."
                                                        },
                                                        "is_listed_individually": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the policy names this possession, rather than covering it under the general contents of the home."
                                                        },
                                                        "contact_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Who to call at the insurer, or null."
                                                        },
                                                        "contact_email": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The email of that person, or null."
                                                        },
                                                        "contact_phone": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The phone of that person, or null."
                                                        },
                                                        "note": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Conditions, exclusions, what the insurer asked for, or null."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the record was added, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The Insurance section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_insurance_record",
                                        "id": "5a2e8c14-6b3f-4d71-9e08-c7f1a3b5d2e6",
                                        "attributes": {
                                            "insurer": "Sabre Insurance",
                                            "status": "active",
                                            "is_current": true,
                                            "policy_number": "SAB-2026-0042",
                                            "coverage": "Theft, fire and accidental damage",
                                            "insured_value": "500.00",
                                            "excess": "50.00",
                                            "currency": "usd",
                                            "starts_on": "2026-01-01",
                                            "ends_on": "2027-01-01",
                                            "is_listed_individually": true,
                                            "contact_name": "Gabe Lewis",
                                            "contact_email": "gabe@sabre.example.com",
                                            "contact_phone": null,
                                            "note": "Not covered when Michael lends it to Dwight.",
                                            "created_at": 1761436800,
                                            "updated_at": 1761436800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/insurance-records/5a2e8c14-6b3f-4d71-9e08-c7f1a3b5d2e6",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/insurance"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "possession-insurance-records-show-query",
                "tags": [
                    "Possession insurance records"
                ],
                "summary": "Get an insurance record",
                "description": "Retrieve one insurance record of a possession.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "insuranceRecord",
                        "in": "path",
                        "required": true,
                        "description": "The id of the insurance record. A record of another possession answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "An insurance record object. A vault, a possession or a record of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession insurance record.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_insurance_record. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "insurer": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Who insures the possession, as text."
                                                        },
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the policy stands: active, pending, expired or cancelled. It is the one entered and never follows the dates."
                                                        },
                                                        "is_current": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether this is the record the possession is insured under now: the active one with the latest start."
                                                        },
                                                        "policy_number": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The number of the policy, or null."
                                                        },
                                                        "coverage": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the policy covers, or null."
                                                        },
                                                        "insured_value": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The value the possession is insured for, as a string with two decimals."
                                                        },
                                                        "excess": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What is paid before the insurer pays, or null when it is not recorded."
                                                        },
                                                        "currency": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The currency of the insured value and the excess, in lower case. Nothing is ever converted."
                                                        },
                                                        "starts_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day the policy period starts, written as 2026-01-01, or null."
                                                        },
                                                        "ends_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day the policy period ends or renews, or null for a policy with no end date."
                                                        },
                                                        "is_listed_individually": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the policy names this possession, rather than covering it under the general contents of the home."
                                                        },
                                                        "contact_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Who to call at the insurer, or null."
                                                        },
                                                        "contact_email": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The email of that person, or null."
                                                        },
                                                        "contact_phone": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The phone of that person, or null."
                                                        },
                                                        "note": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Conditions, exclusions, what the insurer asked for, or null."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the record was added, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The Insurance section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_insurance_record",
                                        "id": "5a2e8c14-6b3f-4d71-9e08-c7f1a3b5d2e6",
                                        "attributes": {
                                            "insurer": "Sabre Insurance",
                                            "status": "active",
                                            "is_current": true,
                                            "policy_number": "SAB-2026-0042",
                                            "coverage": "Theft, fire and accidental damage",
                                            "insured_value": "500.00",
                                            "excess": "50.00",
                                            "currency": "usd",
                                            "starts_on": "2026-01-01",
                                            "ends_on": "2027-01-01",
                                            "is_listed_individually": true,
                                            "contact_name": "Gabe Lewis",
                                            "contact_email": "gabe@sabre.example.com",
                                            "contact_phone": null,
                                            "note": "Not covered when Michael lends it to Dwight.",
                                            "created_at": 1761436800,
                                            "updated_at": 1761436800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/insurance-records/5a2e8c14-6b3f-4d71-9e08-c7f1a3b5d2e6",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/insurance"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "put": {
                "operationId": "possession-insurance-records-update",
                "tags": [
                    "Possession insurance records"
                ],
                "summary": "Change an insurance record",
                "description": "Change what one insurance record says, under the rules that recorded it.\n\nA field left out of the request keeps its value, and a field sent as null is cleared. The other records are not touched.\n\nThe change is written to the account log.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "insuranceRecord",
                        "in": "path",
                        "required": true,
                        "description": "The id of the insurance record. A record of another possession answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "insurer": {
                                        "type": "string",
                                        "description": "Who insures the possession, up to 255 characters."
                                    },
                                    "status": {
                                        "type": "string",
                                        "description": "Where the policy stands: active, pending, expired or cancelled."
                                    },
                                    "insured_value": {
                                        "type": "string",
                                        "description": "The value the possession is insured for. Zero or more, up to 9999999999.99. A figure below zero is refused with “Write an amount of zero or more.”"
                                    },
                                    "currency": {
                                        "type": "string",
                                        "description": "The currency of the insured value and the excess."
                                    },
                                    "policy_number": {
                                        "type": "string",
                                        "description": "The number of the policy, up to 255 characters."
                                    },
                                    "coverage": {
                                        "type": "string",
                                        "description": "What the policy covers, up to 255 characters."
                                    },
                                    "excess": {
                                        "type": "string",
                                        "description": "What is paid before the insurer pays. Zero or more, up to 9999999999.99. A figure below zero is refused with “Write an amount of zero or more.”"
                                    },
                                    "starts_on": {
                                        "type": "string",
                                        "description": "The day the policy period starts, written as 2026-01-01."
                                    },
                                    "ends_on": {
                                        "type": "string",
                                        "description": "The day the policy period ends or renews, written as 2027-01-01. A day before the start is refused with “The end cannot come before the start.”"
                                    },
                                    "is_listed_individually": {
                                        "type": "boolean",
                                        "description": "Whether the policy names this possession rather than the general contents of the home. False when left out on creation."
                                    },
                                    "contact_name": {
                                        "type": "string",
                                        "description": "Who to call at the insurer, up to 255 characters."
                                    },
                                    "contact_email": {
                                        "type": "string",
                                        "description": "The email of that person, a full email address."
                                    },
                                    "contact_phone": {
                                        "type": "string",
                                        "description": "The phone of that person, up to 50 characters."
                                    },
                                    "note": {
                                        "type": "string",
                                        "description": "Conditions, exclusions, what the insurer asked for, up to 5,000 characters."
                                    }
                                }
                            },
                            "example": {
                                "status": "expired",
                                "policy_number": "SAB-2026-0042",
                                "coverage": "Theft, fire and accidental damage",
                                "excess": 50,
                                "starts_on": "2026-01-01",
                                "ends_on": "2027-01-01",
                                "is_listed_individually": true,
                                "contact_name": "Gabe Lewis",
                                "contact_email": "gabe@sabre.example.com",
                                "note": "Not covered when Michael lends it to Dwight."
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The insurance record object as it now reads. A record of another possession or of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession insurance record.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_insurance_record. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "insurer": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Who insures the possession, as text."
                                                        },
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the policy stands: active, pending, expired or cancelled. It is the one entered and never follows the dates."
                                                        },
                                                        "is_current": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether this is the record the possession is insured under now: the active one with the latest start."
                                                        },
                                                        "policy_number": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The number of the policy, or null."
                                                        },
                                                        "coverage": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the policy covers, or null."
                                                        },
                                                        "insured_value": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The value the possession is insured for, as a string with two decimals."
                                                        },
                                                        "excess": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What is paid before the insurer pays, or null when it is not recorded."
                                                        },
                                                        "currency": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The currency of the insured value and the excess, in lower case. Nothing is ever converted."
                                                        },
                                                        "starts_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day the policy period starts, written as 2026-01-01, or null."
                                                        },
                                                        "ends_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day the policy period ends or renews, or null for a policy with no end date."
                                                        },
                                                        "is_listed_individually": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the policy names this possession, rather than covering it under the general contents of the home."
                                                        },
                                                        "contact_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Who to call at the insurer, or null."
                                                        },
                                                        "contact_email": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The email of that person, or null."
                                                        },
                                                        "contact_phone": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The phone of that person, or null."
                                                        },
                                                        "note": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Conditions, exclusions, what the insurer asked for, or null."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the record was added, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The Insurance section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_insurance_record",
                                        "id": "5a2e8c14-6b3f-4d71-9e08-c7f1a3b5d2e6",
                                        "attributes": {
                                            "insurer": "Sabre Insurance",
                                            "status": "active",
                                            "is_current": true,
                                            "policy_number": "SAB-2026-0042",
                                            "coverage": "Theft, fire and accidental damage",
                                            "insured_value": "500.00",
                                            "excess": "50.00",
                                            "currency": "usd",
                                            "starts_on": "2026-01-01",
                                            "ends_on": "2027-01-01",
                                            "is_listed_individually": true,
                                            "contact_name": "Gabe Lewis",
                                            "contact_email": "gabe@sabre.example.com",
                                            "contact_phone": null,
                                            "note": "Not covered when Michael lends it to Dwight.",
                                            "created_at": 1761436800,
                                            "updated_at": 1761436800
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/insurance-records/5a2e8c14-6b3f-4d71-9e08-c7f1a3b5d2e6",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/insurance"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "delete": {
                "operationId": "possession-insurance-records-destroy",
                "tags": [
                    "Possession insurance records"
                ],
                "summary": "Delete an insurance record",
                "description": "Delete an insurance record of a possession.\n\nThe deletion is final, and the history of the coverage loses that policy period. The account log keeps the name of the possession.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "insuranceRecord",
                        "in": "path",
                        "required": true,
                        "description": "The id of the insurance record. A record of another possession answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Nothing. A record of another possession or of another account answers 404."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/possessions/{possession}/maintenance-records": {
            "get": {
                "operationId": "possession-maintenance-records-index",
                "tags": [
                    "Possession maintenance records"
                ],
                "summary": "List the maintenance records of a possession",
                "description": "List every maintenance record of a possession, the latest job first.\n\nThe record with the latest day performed comes first, and on the same day the one added last comes first. The first record is therefore the only one that can be overdue. The list is whole rather than paginated.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Every maintenance record object of the possession, or an empty list. A vault or a possession of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "Every one of the possession maintenance records, whole rather than a page at a time.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One possession maintenance record.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always possession_maintenance_record. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "maintenance_type": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What kind of job it was: inspection, cleaning, servicing, repair, restoration, part_replacement, conservation or other."
                                                            },
                                                            "title": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What was done, as text."
                                                            },
                                                            "performed_by": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The person or the workshop who did the job, as text, or null."
                                                            },
                                                            "performed_on": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The day the job was done, written as 2026-03-12."
                                                            },
                                                            "cost": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the job cost, as a string with two decimals, or null when it is not recorded. It is never added to the transactions or to the declared value of the possession."
                                                            },
                                                            "currency": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The currency of the cost, in lower case, or null when there is no cost. Nothing is ever converted."
                                                            },
                                                            "condition_before": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The possession condition the possession was in before the job, or null when it is not recorded. A condition renamed since gives its new name, and one deleted since leaves null.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the condition, as the possession conditions endpoints give it."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the condition is called."
                                                                    }
                                                                }
                                                            },
                                                            "condition_after": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The possession condition the possession was in after the job, or null when it is not recorded. A condition renamed since gives its new name, and one deleted since leaves null.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the condition, as the possession conditions endpoints give it."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the condition is called."
                                                                    }
                                                                }
                                                            },
                                                            "next_due_on": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The day the job should be done again, or null when nothing is scheduled."
                                                            },
                                                            "is_overdue": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the job is due again and has not been done. Only the latest record of the possession can be overdue, since a later job replaces the schedule of an earlier one, and it is overdue when its next due date is before today, in the timezone of the user the key belongs to. It is read, never written."
                                                            },
                                                            "description": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What was found and what was done, or null."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the record was added, as a count of seconds since 1970."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds, or null."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The Maintenance section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "possession_maintenance_record",
                                            "id": "3f8b1d62-7a4c-4e95-b2d0-6c1e9a5f7b38",
                                            "attributes": {
                                                "maintenance_type": "restoration",
                                                "title": "Re-plating",
                                                "performed_by": "Scranton Trophy and Engraving",
                                                "performed_on": "2026-03-12",
                                                "cost": "40.00",
                                                "currency": "usd",
                                                "condition_before": {
                                                    "id": "d4a91f3e-6b27-4c58-8e0d-1f5a7c3b9e62",
                                                    "name": "Worn"
                                                },
                                                "condition_after": {
                                                    "id": "6e2c8b47-1a95-4d3f-b706-9c4e2f1a8d53",
                                                    "name": "Like new"
                                                },
                                                "next_due_on": "2027-03-12",
                                                "is_overdue": false,
                                                "description": "The gold finish had worn through on the base. Michael wants it ready for the next Dundies.",
                                                "created_at": 1773331200,
                                                "updated_at": 1773331200
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/maintenance-records/3f8b1d62-7a4c-4e95-b2d0-6c1e9a5f7b38",
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/maintenance"
                                            }
                                        },
                                        {
                                            "type": "possession_maintenance_record",
                                            "id": "b71c5e09-2d36-4f8a-9e14-0a6d3b8c2f57",
                                            "attributes": {
                                                "maintenance_type": "inspection",
                                                "title": "Engraving check",
                                                "performed_by": null,
                                                "performed_on": "2025-02-14",
                                                "cost": null,
                                                "currency": null,
                                                "condition_before": {
                                                    "id": "d4a91f3e-6b27-4c58-8e0d-1f5a7c3b9e62",
                                                    "name": "Worn"
                                                },
                                                "condition_after": null,
                                                "next_due_on": "2026-02-14",
                                                "is_overdue": false,
                                                "description": null,
                                                "created_at": 1739545200,
                                                "updated_at": 1739545200
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/maintenance-records/b71c5e09-2d36-4f8a-9e14-0a6d3b8c2f57",
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/maintenance"
                                            }
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "possession-maintenance-records-index-query",
                "tags": [
                    "Possession maintenance records"
                ],
                "summary": "List the maintenance records of a possession",
                "description": "List every maintenance record of a possession, the latest job first.\n\nThe record with the latest day performed comes first, and on the same day the one added last comes first. The first record is therefore the only one that can be overdue. The list is whole rather than paginated.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Every maintenance record object of the possession, or an empty list. A vault or a possession of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "Every one of the possession maintenance records, whole rather than a page at a time.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One possession maintenance record.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always possession_maintenance_record. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "maintenance_type": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What kind of job it was: inspection, cleaning, servicing, repair, restoration, part_replacement, conservation or other."
                                                            },
                                                            "title": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What was done, as text."
                                                            },
                                                            "performed_by": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The person or the workshop who did the job, as text, or null."
                                                            },
                                                            "performed_on": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The day the job was done, written as 2026-03-12."
                                                            },
                                                            "cost": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the job cost, as a string with two decimals, or null when it is not recorded. It is never added to the transactions or to the declared value of the possession."
                                                            },
                                                            "currency": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The currency of the cost, in lower case, or null when there is no cost. Nothing is ever converted."
                                                            },
                                                            "condition_before": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The possession condition the possession was in before the job, or null when it is not recorded. A condition renamed since gives its new name, and one deleted since leaves null.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the condition, as the possession conditions endpoints give it."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the condition is called."
                                                                    }
                                                                }
                                                            },
                                                            "condition_after": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The possession condition the possession was in after the job, or null when it is not recorded. A condition renamed since gives its new name, and one deleted since leaves null.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the condition, as the possession conditions endpoints give it."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the condition is called."
                                                                    }
                                                                }
                                                            },
                                                            "next_due_on": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The day the job should be done again, or null when nothing is scheduled."
                                                            },
                                                            "is_overdue": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the job is due again and has not been done. Only the latest record of the possession can be overdue, since a later job replaces the schedule of an earlier one, and it is overdue when its next due date is before today, in the timezone of the user the key belongs to. It is read, never written."
                                                            },
                                                            "description": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What was found and what was done, or null."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the record was added, as a count of seconds since 1970."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds, or null."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The Maintenance section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "possession_maintenance_record",
                                            "id": "3f8b1d62-7a4c-4e95-b2d0-6c1e9a5f7b38",
                                            "attributes": {
                                                "maintenance_type": "restoration",
                                                "title": "Re-plating",
                                                "performed_by": "Scranton Trophy and Engraving",
                                                "performed_on": "2026-03-12",
                                                "cost": "40.00",
                                                "currency": "usd",
                                                "condition_before": {
                                                    "id": "d4a91f3e-6b27-4c58-8e0d-1f5a7c3b9e62",
                                                    "name": "Worn"
                                                },
                                                "condition_after": {
                                                    "id": "6e2c8b47-1a95-4d3f-b706-9c4e2f1a8d53",
                                                    "name": "Like new"
                                                },
                                                "next_due_on": "2027-03-12",
                                                "is_overdue": false,
                                                "description": "The gold finish had worn through on the base. Michael wants it ready for the next Dundies.",
                                                "created_at": 1773331200,
                                                "updated_at": 1773331200
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/maintenance-records/3f8b1d62-7a4c-4e95-b2d0-6c1e9a5f7b38",
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/maintenance"
                                            }
                                        },
                                        {
                                            "type": "possession_maintenance_record",
                                            "id": "b71c5e09-2d36-4f8a-9e14-0a6d3b8c2f57",
                                            "attributes": {
                                                "maintenance_type": "inspection",
                                                "title": "Engraving check",
                                                "performed_by": null,
                                                "performed_on": "2025-02-14",
                                                "cost": null,
                                                "currency": null,
                                                "condition_before": {
                                                    "id": "d4a91f3e-6b27-4c58-8e0d-1f5a7c3b9e62",
                                                    "name": "Worn"
                                                },
                                                "condition_after": null,
                                                "next_due_on": "2026-02-14",
                                                "is_overdue": false,
                                                "description": null,
                                                "created_at": 1739545200,
                                                "updated_at": 1739545200
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/maintenance-records/b71c5e09-2d36-4f8a-9e14-0a6d3b8c2f57",
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/maintenance"
                                            }
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "post": {
                "operationId": "possession-maintenance-records-create",
                "tags": [
                    "Possession maintenance records"
                ],
                "summary": "Add a maintenance record",
                "description": "Record one job done on a possession.\n\nThe type, the title and the day performed are required.\n\nThe change is written to the account log.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "maintenance_type": {
                                        "type": "string",
                                        "description": "What kind of job it was: inspection, cleaning, servicing, repair, restoration, part_replacement, conservation or other."
                                    },
                                    "title": {
                                        "type": "string",
                                        "description": "What was done, up to 255 characters. Markup is stripped, and a title left empty once it is stripped is refused with “Say what was done.”"
                                    },
                                    "performed_on": {
                                        "type": "string",
                                        "description": "The day the job was done, written as 2026-03-12. A day after today, in the timezone of the user the key belongs to, is refused with “The job cannot be performed in the future.”"
                                    },
                                    "performed_by": {
                                        "type": "string",
                                        "description": "The person or the workshop who did the job, up to 255 characters."
                                    },
                                    "cost": {
                                        "type": "string",
                                        "description": "What the job cost. Zero or more, up to 9999999999.99. A figure below zero is refused."
                                    },
                                    "currency": {
                                        "type": "string",
                                        "description": "The currency of the cost: usd, eur, gbp, cad, aud, chf, jpy, brl, inr or cny. A cost sent without one is refused with “Choose the currency of the cost.”"
                                    },
                                    "condition_before_id": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "The condition the possession was in before the job. The id of one of the possession conditions of your account, or null for none. A condition of another account answers 404."
                                    },
                                    "condition_after_id": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "The condition the possession was in after the job. The id of one of the possession conditions of your account, or null for none. A condition of another account answers 404."
                                    },
                                    "next_due_on": {
                                        "type": "string",
                                        "description": "The day the job should be done again, written as 2027-03-12. A day before the job is refused with “The next due date cannot come before the job.”"
                                    },
                                    "description": {
                                        "type": "string",
                                        "description": "What was found and what was done, up to 5,000 characters. Markup is stripped."
                                    }
                                },
                                "required": [
                                    "maintenance_type",
                                    "title",
                                    "performed_on"
                                ]
                            },
                            "example": {
                                "maintenance_type": "restoration",
                                "title": "Re-plating",
                                "performed_on": "2026-03-12",
                                "performed_by": "Scranton Trophy and Engraving",
                                "cost": 40,
                                "currency": "usd",
                                "condition_before_id": "d4a91f3e-6b27-4c58-8e0d-1f5a7c3b9e62",
                                "condition_after_id": "6e2c8b47-1a95-4d3f-b706-9c4e2f1a8d53",
                                "next_due_on": "2027-03-12",
                                "description": "The gold finish had worn through on the base. Michael wants it ready for the next Dundies."
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The maintenance record object that was added. A condition of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession maintenance record.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_maintenance_record. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "maintenance_type": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What kind of job it was: inspection, cleaning, servicing, repair, restoration, part_replacement, conservation or other."
                                                        },
                                                        "title": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What was done, as text."
                                                        },
                                                        "performed_by": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The person or the workshop who did the job, as text, or null."
                                                        },
                                                        "performed_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day the job was done, written as 2026-03-12."
                                                        },
                                                        "cost": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the job cost, as a string with two decimals, or null when it is not recorded. It is never added to the transactions or to the declared value of the possession."
                                                        },
                                                        "currency": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The currency of the cost, in lower case, or null when there is no cost. Nothing is ever converted."
                                                        },
                                                        "condition_before": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The possession condition the possession was in before the job, or null when it is not recorded. A condition renamed since gives its new name, and one deleted since leaves null.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the condition, as the possession conditions endpoints give it."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What the condition is called."
                                                                }
                                                            }
                                                        },
                                                        "condition_after": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The possession condition the possession was in after the job, or null when it is not recorded. A condition renamed since gives its new name, and one deleted since leaves null.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the condition, as the possession conditions endpoints give it."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What the condition is called."
                                                                }
                                                            }
                                                        },
                                                        "next_due_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day the job should be done again, or null when nothing is scheduled."
                                                        },
                                                        "is_overdue": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the job is due again and has not been done. Only the latest record of the possession can be overdue, since a later job replaces the schedule of an earlier one, and it is overdue when its next due date is before today, in the timezone of the user the key belongs to. It is read, never written."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What was found and what was done, or null."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the record was added, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The Maintenance section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_maintenance_record",
                                        "id": "3f8b1d62-7a4c-4e95-b2d0-6c1e9a5f7b38",
                                        "attributes": {
                                            "maintenance_type": "restoration",
                                            "title": "Re-plating",
                                            "performed_by": "Scranton Trophy and Engraving",
                                            "performed_on": "2026-03-12",
                                            "cost": "40.00",
                                            "currency": "usd",
                                            "condition_before": {
                                                "id": "d4a91f3e-6b27-4c58-8e0d-1f5a7c3b9e62",
                                                "name": "Worn"
                                            },
                                            "condition_after": {
                                                "id": "6e2c8b47-1a95-4d3f-b706-9c4e2f1a8d53",
                                                "name": "Like new"
                                            },
                                            "next_due_on": "2027-03-12",
                                            "is_overdue": false,
                                            "description": "The gold finish had worn through on the base. Michael wants it ready for the next Dundies.",
                                            "created_at": 1773331200,
                                            "updated_at": 1773331200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/maintenance-records/3f8b1d62-7a4c-4e95-b2d0-6c1e9a5f7b38",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/maintenance"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/possessions/{possession}/maintenance-records/{maintenanceRecord}": {
            "get": {
                "operationId": "possession-maintenance-records-show",
                "tags": [
                    "Possession maintenance records"
                ],
                "summary": "Get a maintenance record",
                "description": "Retrieve one maintenance record of a possession.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "maintenanceRecord",
                        "in": "path",
                        "required": true,
                        "description": "The id of the maintenance record. A record of another possession answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A maintenance record object. A vault, a possession or a record of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession maintenance record.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_maintenance_record. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "maintenance_type": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What kind of job it was: inspection, cleaning, servicing, repair, restoration, part_replacement, conservation or other."
                                                        },
                                                        "title": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What was done, as text."
                                                        },
                                                        "performed_by": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The person or the workshop who did the job, as text, or null."
                                                        },
                                                        "performed_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day the job was done, written as 2026-03-12."
                                                        },
                                                        "cost": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the job cost, as a string with two decimals, or null when it is not recorded. It is never added to the transactions or to the declared value of the possession."
                                                        },
                                                        "currency": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The currency of the cost, in lower case, or null when there is no cost. Nothing is ever converted."
                                                        },
                                                        "condition_before": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The possession condition the possession was in before the job, or null when it is not recorded. A condition renamed since gives its new name, and one deleted since leaves null.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the condition, as the possession conditions endpoints give it."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What the condition is called."
                                                                }
                                                            }
                                                        },
                                                        "condition_after": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The possession condition the possession was in after the job, or null when it is not recorded. A condition renamed since gives its new name, and one deleted since leaves null.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the condition, as the possession conditions endpoints give it."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What the condition is called."
                                                                }
                                                            }
                                                        },
                                                        "next_due_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day the job should be done again, or null when nothing is scheduled."
                                                        },
                                                        "is_overdue": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the job is due again and has not been done. Only the latest record of the possession can be overdue, since a later job replaces the schedule of an earlier one, and it is overdue when its next due date is before today, in the timezone of the user the key belongs to. It is read, never written."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What was found and what was done, or null."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the record was added, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The Maintenance section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_maintenance_record",
                                        "id": "3f8b1d62-7a4c-4e95-b2d0-6c1e9a5f7b38",
                                        "attributes": {
                                            "maintenance_type": "restoration",
                                            "title": "Re-plating",
                                            "performed_by": "Scranton Trophy and Engraving",
                                            "performed_on": "2026-03-12",
                                            "cost": "40.00",
                                            "currency": "usd",
                                            "condition_before": {
                                                "id": "d4a91f3e-6b27-4c58-8e0d-1f5a7c3b9e62",
                                                "name": "Worn"
                                            },
                                            "condition_after": {
                                                "id": "6e2c8b47-1a95-4d3f-b706-9c4e2f1a8d53",
                                                "name": "Like new"
                                            },
                                            "next_due_on": "2027-03-12",
                                            "is_overdue": false,
                                            "description": "The gold finish had worn through on the base. Michael wants it ready for the next Dundies.",
                                            "created_at": 1773331200,
                                            "updated_at": 1773331200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/maintenance-records/3f8b1d62-7a4c-4e95-b2d0-6c1e9a5f7b38",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/maintenance"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "possession-maintenance-records-show-query",
                "tags": [
                    "Possession maintenance records"
                ],
                "summary": "Get a maintenance record",
                "description": "Retrieve one maintenance record of a possession.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "maintenanceRecord",
                        "in": "path",
                        "required": true,
                        "description": "The id of the maintenance record. A record of another possession answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A maintenance record object. A vault, a possession or a record of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession maintenance record.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_maintenance_record. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "maintenance_type": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What kind of job it was: inspection, cleaning, servicing, repair, restoration, part_replacement, conservation or other."
                                                        },
                                                        "title": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What was done, as text."
                                                        },
                                                        "performed_by": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The person or the workshop who did the job, as text, or null."
                                                        },
                                                        "performed_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day the job was done, written as 2026-03-12."
                                                        },
                                                        "cost": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the job cost, as a string with two decimals, or null when it is not recorded. It is never added to the transactions or to the declared value of the possession."
                                                        },
                                                        "currency": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The currency of the cost, in lower case, or null when there is no cost. Nothing is ever converted."
                                                        },
                                                        "condition_before": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The possession condition the possession was in before the job, or null when it is not recorded. A condition renamed since gives its new name, and one deleted since leaves null.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the condition, as the possession conditions endpoints give it."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What the condition is called."
                                                                }
                                                            }
                                                        },
                                                        "condition_after": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The possession condition the possession was in after the job, or null when it is not recorded. A condition renamed since gives its new name, and one deleted since leaves null.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the condition, as the possession conditions endpoints give it."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What the condition is called."
                                                                }
                                                            }
                                                        },
                                                        "next_due_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day the job should be done again, or null when nothing is scheduled."
                                                        },
                                                        "is_overdue": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the job is due again and has not been done. Only the latest record of the possession can be overdue, since a later job replaces the schedule of an earlier one, and it is overdue when its next due date is before today, in the timezone of the user the key belongs to. It is read, never written."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What was found and what was done, or null."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the record was added, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The Maintenance section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_maintenance_record",
                                        "id": "3f8b1d62-7a4c-4e95-b2d0-6c1e9a5f7b38",
                                        "attributes": {
                                            "maintenance_type": "restoration",
                                            "title": "Re-plating",
                                            "performed_by": "Scranton Trophy and Engraving",
                                            "performed_on": "2026-03-12",
                                            "cost": "40.00",
                                            "currency": "usd",
                                            "condition_before": {
                                                "id": "d4a91f3e-6b27-4c58-8e0d-1f5a7c3b9e62",
                                                "name": "Worn"
                                            },
                                            "condition_after": {
                                                "id": "6e2c8b47-1a95-4d3f-b706-9c4e2f1a8d53",
                                                "name": "Like new"
                                            },
                                            "next_due_on": "2027-03-12",
                                            "is_overdue": false,
                                            "description": "The gold finish had worn through on the base. Michael wants it ready for the next Dundies.",
                                            "created_at": 1773331200,
                                            "updated_at": 1773331200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/maintenance-records/3f8b1d62-7a4c-4e95-b2d0-6c1e9a5f7b38",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/maintenance"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "put": {
                "operationId": "possession-maintenance-records-update",
                "tags": [
                    "Possession maintenance records"
                ],
                "summary": "Change a maintenance record",
                "description": "Change what one maintenance record says, under the rules that recorded it.\n\nA field left out of the request keeps its value, and an optional field sent as null is cleared. The other records are not touched, but which record is overdue follows the change.\n\nThe change is written to the account log.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "maintenanceRecord",
                        "in": "path",
                        "required": true,
                        "description": "The id of the maintenance record. A record of another possession answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "maintenance_type": {
                                        "type": "string",
                                        "description": "What kind of job it was: inspection, cleaning, servicing, repair, restoration, part_replacement, conservation or other."
                                    },
                                    "title": {
                                        "type": "string",
                                        "description": "What was done, up to 255 characters. Markup is stripped, and a title left empty once it is stripped is refused with “Say what was done.”"
                                    },
                                    "performed_on": {
                                        "type": "string",
                                        "description": "The day the job was done, written as 2026-03-12. A day after today, in the timezone of the user the key belongs to, is refused with “The job cannot be performed in the future.”"
                                    },
                                    "performed_by": {
                                        "type": "string",
                                        "description": "The person or the workshop who did the job, up to 255 characters."
                                    },
                                    "cost": {
                                        "type": "string",
                                        "description": "What the job cost. Zero or more, up to 9999999999.99. A figure below zero is refused."
                                    },
                                    "currency": {
                                        "type": "string",
                                        "description": "The currency of the cost: usd, eur, gbp, cad, aud, chf, jpy, brl, inr or cny. A cost sent without one is refused with “Choose the currency of the cost.”"
                                    },
                                    "condition_before_id": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "The condition the possession was in before the job. The id of one of the possession conditions of your account, or null for none. A condition of another account answers 404."
                                    },
                                    "condition_after_id": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "The condition the possession was in after the job. The id of one of the possession conditions of your account, or null for none. A condition of another account answers 404."
                                    },
                                    "next_due_on": {
                                        "type": "string",
                                        "description": "The day the job should be done again, written as 2027-03-12. A day before the job is refused with “The next due date cannot come before the job.”"
                                    },
                                    "description": {
                                        "type": "string",
                                        "description": "What was found and what was done, up to 5,000 characters. Markup is stripped."
                                    }
                                }
                            },
                            "example": {
                                "performed_by": "Scranton Trophy and Engraving",
                                "cost": 40,
                                "currency": "usd",
                                "condition_before_id": "d4a91f3e-6b27-4c58-8e0d-1f5a7c3b9e62",
                                "condition_after_id": "6e2c8b47-1a95-4d3f-b706-9c4e2f1a8d53",
                                "next_due_on": "2027-03-12",
                                "description": "The gold finish had worn through on the base. Michael wants it ready for the next Dundies."
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The maintenance record object as it now reads. A record of another possession or of another account, or a condition of another account, answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession maintenance record.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_maintenance_record. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "maintenance_type": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What kind of job it was: inspection, cleaning, servicing, repair, restoration, part_replacement, conservation or other."
                                                        },
                                                        "title": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What was done, as text."
                                                        },
                                                        "performed_by": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The person or the workshop who did the job, as text, or null."
                                                        },
                                                        "performed_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day the job was done, written as 2026-03-12."
                                                        },
                                                        "cost": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the job cost, as a string with two decimals, or null when it is not recorded. It is never added to the transactions or to the declared value of the possession."
                                                        },
                                                        "currency": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The currency of the cost, in lower case, or null when there is no cost. Nothing is ever converted."
                                                        },
                                                        "condition_before": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The possession condition the possession was in before the job, or null when it is not recorded. A condition renamed since gives its new name, and one deleted since leaves null.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the condition, as the possession conditions endpoints give it."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What the condition is called."
                                                                }
                                                            }
                                                        },
                                                        "condition_after": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The possession condition the possession was in after the job, or null when it is not recorded. A condition renamed since gives its new name, and one deleted since leaves null.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the condition, as the possession conditions endpoints give it."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What the condition is called."
                                                                }
                                                            }
                                                        },
                                                        "next_due_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day the job should be done again, or null when nothing is scheduled."
                                                        },
                                                        "is_overdue": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the job is due again and has not been done. Only the latest record of the possession can be overdue, since a later job replaces the schedule of an earlier one, and it is overdue when its next due date is before today, in the timezone of the user the key belongs to. It is read, never written."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What was found and what was done, or null."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the record was added, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The Maintenance section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_maintenance_record",
                                        "id": "3f8b1d62-7a4c-4e95-b2d0-6c1e9a5f7b38",
                                        "attributes": {
                                            "maintenance_type": "restoration",
                                            "title": "Re-plating",
                                            "performed_by": "Scranton Trophy and Engraving",
                                            "performed_on": "2026-03-12",
                                            "cost": "40.00",
                                            "currency": "usd",
                                            "condition_before": {
                                                "id": "d4a91f3e-6b27-4c58-8e0d-1f5a7c3b9e62",
                                                "name": "Worn"
                                            },
                                            "condition_after": {
                                                "id": "6e2c8b47-1a95-4d3f-b706-9c4e2f1a8d53",
                                                "name": "Like new"
                                            },
                                            "next_due_on": "2027-03-12",
                                            "is_overdue": false,
                                            "description": "The gold finish had worn through on the base. Michael wants it ready for the next Dundies.",
                                            "created_at": 1773331200,
                                            "updated_at": 1773331200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/maintenance-records/3f8b1d62-7a4c-4e95-b2d0-6c1e9a5f7b38",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/maintenance"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "delete": {
                "operationId": "possession-maintenance-records-destroy",
                "tags": [
                    "Possession maintenance records"
                ],
                "summary": "Delete a maintenance record",
                "description": "Delete a maintenance record of a possession.\n\nThe deletion is final, and the maintenance history loses that job. When it was the latest record, the one before it becomes the latest, and its next due date counts again. The account log keeps the name of the possession.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "maintenanceRecord",
                        "in": "path",
                        "required": true,
                        "description": "The id of the maintenance record. A record of another possession answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Nothing. A record of another possession or of another account answers 404."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/support-requests": {
            "get": {
                "operationId": "support-requests-index",
                "tags": [
                    "Support requests"
                ],
                "summary": "List support requests",
                "description": "List the support requests of your account, the most recently active first. The messages are left out of a list. Read one request to get its thread.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "status",
                        "in": "query",
                        "required": false,
                        "description": "Keep only the requests in this status: to_handle, waiting_on_user or solved. Any other value answers 422 on status.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to answer with.",
                        "schema": {
                            "type": "integer",
                            "default": 1
                        }
                    },
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "How many records one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused.",
                        "schema": {
                            "type": "integer",
                            "default": 25
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of support request objects, and how many there are in all. Only the requests of your account are listed.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The support requests on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One support request.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always support_request. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "reference": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The reference to quote when writing to the support team, such as MON-482913."
                                                            },
                                                            "category": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the request is about: feature, billing, email, question or technical."
                                                            },
                                                            "subject": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The title the request was opened with."
                                                            },
                                                            "status": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Where the request stands: to_handle when the support team has yet to answer, waiting_on_user when it has and awaits you, or solved."
                                                            },
                                                            "status_label": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The status as the application words it for the person who asked, in the language of the account."
                                                            },
                                                            "opened_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the request was opened, as a count of seconds since 1970."
                                                            },
                                                            "last_activity_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When anybody last wrote in it, the person who asked or the support team, as a count of seconds since 1970. A change of status alone does not move it."
                                                            },
                                                            "solved_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it was marked as solved, as a count of seconds since 1970, or null while it is open."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "support_request",
                                            "id": "7c1e4a92-5b3d-4f08-a6e1-93d2c8b05f17",
                                            "attributes": {
                                                "reference": "MON-482913",
                                                "category": "question",
                                                "subject": "My conference room reminder never arrived",
                                                "status": "waiting_on_user",
                                                "status_label": "Reply from support",
                                                "opened_at": 1791547200,
                                                "last_activity_at": 1791550800,
                                                "solved_at": null
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/support-requests/7c1e4a92-5b3d-4f08-a6e1-93d2c8b05f17"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "support-requests-index-query",
                "tags": [
                    "Support requests"
                ],
                "summary": "List support requests",
                "description": "List the support requests of your account, the most recently active first. The messages are left out of a list. Read one request to get its thread.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "status": {
                                        "type": "string",
                                        "description": "Keep only the requests in this status: to_handle, waiting_on_user or solved. Any other value answers 422 on status."
                                    },
                                    "page": {
                                        "type": "integer",
                                        "default": 1,
                                        "description": "Which page to answer with."
                                    },
                                    "per_page": {
                                        "type": "integer",
                                        "default": 25,
                                        "description": "How many records one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "A page of support request objects, and how many there are in all. Only the requests of your account are listed.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The support requests on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One support request.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always support_request. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "reference": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The reference to quote when writing to the support team, such as MON-482913."
                                                            },
                                                            "category": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the request is about: feature, billing, email, question or technical."
                                                            },
                                                            "subject": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The title the request was opened with."
                                                            },
                                                            "status": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Where the request stands: to_handle when the support team has yet to answer, waiting_on_user when it has and awaits you, or solved."
                                                            },
                                                            "status_label": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The status as the application words it for the person who asked, in the language of the account."
                                                            },
                                                            "opened_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the request was opened, as a count of seconds since 1970."
                                                            },
                                                            "last_activity_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When anybody last wrote in it, the person who asked or the support team, as a count of seconds since 1970. A change of status alone does not move it."
                                                            },
                                                            "solved_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it was marked as solved, as a count of seconds since 1970, or null while it is open."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "support_request",
                                            "id": "7c1e4a92-5b3d-4f08-a6e1-93d2c8b05f17",
                                            "attributes": {
                                                "reference": "MON-482913",
                                                "category": "question",
                                                "subject": "My conference room reminder never arrived",
                                                "status": "waiting_on_user",
                                                "status_label": "Reply from support",
                                                "opened_at": 1791547200,
                                                "last_activity_at": 1791550800,
                                                "solved_at": null
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/support-requests/7c1e4a92-5b3d-4f08-a6e1-93d2c8b05f17"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "post": {
                "operationId": "support-requests-create",
                "tags": [
                    "Support requests"
                ],
                "summary": "Open a support request",
                "description": "Open a request with the support team. The body becomes the first message of the thread, and the request starts in to_handle.\n\nFiles are sent as multipart form data, in a field called files that is repeated once per file. At most 5 files, each at most 10 MB, of the types jpg, jpeg, png, gif, webp, heic, pdf, txt and log. A file that breaks any of these answers 422 on files or on files.0, files.1 and so on, and nothing is kept.\n\nAn instance that has no active administrator has nobody to answer, so it answers 404 here.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": true,
                    "content": {
                        "multipart/form-data": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "category": {
                                        "type": "string",
                                        "description": "What the request is about: feature, billing, email, question or technical."
                                    },
                                    "subject": {
                                        "type": "string",
                                        "description": "The title of the request, up to 255 characters."
                                    },
                                    "body": {
                                        "type": "string",
                                        "description": "What you want to say, between 10 and 20,000 characters."
                                    },
                                    "files": {
                                        "type": "string",
                                        "format": "binary",
                                        "description": "Files to send with the first message. Repeat the field once per file, up to 5."
                                    }
                                },
                                "required": [
                                    "category",
                                    "subject",
                                    "body"
                                ]
                            },
                            "example": {
                                "category": "question",
                                "subject": "My conference room reminder never arrived",
                                "body": "I booked the conference room for the quarterly meeting, but the reminder never arrived. Dwight says it is a conspiracy."
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The support request object that was opened, with its first message.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The support request.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always support_request. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "reference": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The reference to quote when writing to the support team, such as MON-482913."
                                                        },
                                                        "category": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the request is about: feature, billing, email, question or technical."
                                                        },
                                                        "subject": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The title the request was opened with."
                                                        },
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the request stands: to_handle when the support team has yet to answer, waiting_on_user when it has and awaits you, or solved."
                                                        },
                                                        "status_label": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The status as the application words it for the person who asked, in the language of the account."
                                                        },
                                                        "opened_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the request was opened, as a count of seconds since 1970."
                                                        },
                                                        "last_activity_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When anybody last wrote in it, the person who asked or the support team, as a count of seconds since 1970. A change of status alone does not move it."
                                                        },
                                                        "solved_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it was marked as solved, as a count of seconds since 1970, or null while it is open."
                                                        },
                                                        "messages": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The whole thread, the oldest first, without the internal notes of the support team.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One message of the thread.",
                                                                "properties": {
                                                                    "type": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Always support_message."
                                                                    },
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The id of the message."
                                                                    },
                                                                    "attributes": {
                                                                        "type": [
                                                                            "object",
                                                                            "null"
                                                                        ],
                                                                        "description": "Everything the message holds.",
                                                                        "properties": {
                                                                            "kind": {
                                                                                "type": [
                                                                                    "string",
                                                                                    "null"
                                                                                ],
                                                                                "description": "message when the person who asked wrote it, reply when the support team did. An internal note is never shown here."
                                                                            },
                                                                            "author_name": {
                                                                                "type": [
                                                                                    "string",
                                                                                    "null"
                                                                                ],
                                                                                "description": "The name of the person who wrote it."
                                                                            },
                                                                            "is_support_team": {
                                                                                "type": [
                                                                                    "boolean",
                                                                                    "null"
                                                                                ],
                                                                                "description": "Whether the support team wrote it."
                                                                            },
                                                                            "body": {
                                                                                "type": [
                                                                                    "string",
                                                                                    "null"
                                                                                ],
                                                                                "description": "What was written, as plain text."
                                                                            },
                                                                            "attachments": {
                                                                                "type": [
                                                                                    "array",
                                                                                    "null"
                                                                                ],
                                                                                "description": "The files sent with it. An empty list when there are none.",
                                                                                "items": {
                                                                                    "type": [
                                                                                        "object",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "One file.",
                                                                                    "properties": {
                                                                                        "id": {
                                                                                            "type": [
                                                                                                "string",
                                                                                                "null"
                                                                                            ],
                                                                                            "format": "uuid",
                                                                                            "description": "The id of the file, which the download address takes."
                                                                                        },
                                                                                        "name": {
                                                                                            "type": [
                                                                                                "string",
                                                                                                "null"
                                                                                            ],
                                                                                            "description": "The name the file had when it was sent."
                                                                                        },
                                                                                        "mime_type": {
                                                                                            "type": [
                                                                                                "string",
                                                                                                "null"
                                                                                            ],
                                                                                            "description": "The type of the file, such as image/png."
                                                                                        },
                                                                                        "size_in_bytes": {
                                                                                            "type": [
                                                                                                "integer",
                                                                                                "null"
                                                                                            ],
                                                                                            "description": "How large the file is, in bytes."
                                                                                        }
                                                                                    }
                                                                                }
                                                                            },
                                                                            "created_at": {
                                                                                "type": [
                                                                                    "integer",
                                                                                    "null"
                                                                                ],
                                                                                "description": "When it was written, as a count of seconds since 1970."
                                                                            }
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "support_request",
                                        "id": "7c1e4a92-5b3d-4f08-a6e1-93d2c8b05f17",
                                        "attributes": {
                                            "reference": "MON-482913",
                                            "category": "question",
                                            "subject": "My conference room reminder never arrived",
                                            "status": "to_handle",
                                            "status_label": "Waiting for support",
                                            "opened_at": 1791547200,
                                            "last_activity_at": 1791547200,
                                            "solved_at": null,
                                            "messages": [
                                                {
                                                    "type": "support_message",
                                                    "id": "e5a90b36-1c7d-4284-b9f3-0d6a82c471e9",
                                                    "attributes": {
                                                        "kind": "message",
                                                        "author_name": "Michael Scott",
                                                        "is_support_team": false,
                                                        "body": "I booked the conference room for the quarterly meeting, but the reminder never arrived. Dwight says it is a conspiracy.",
                                                        "attachments": [
                                                            {
                                                                "id": "b36f0d8e-47a1-4c92-95e8-1a2d7c63f0b4",
                                                                "name": "conference-room-booking.png",
                                                                "mime_type": "image/png",
                                                                "size_in_bytes": 245760
                                                            }
                                                        ],
                                                        "created_at": 1791547200
                                                    }
                                                }
                                            ]
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/support-requests/7c1e4a92-5b3d-4f08-a6e1-93d2c8b05f17"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/support-requests/{supportRequest}": {
            "get": {
                "operationId": "support-requests-show",
                "tags": [
                    "Support requests"
                ],
                "summary": "Get a support request",
                "description": "Return one support request with its whole thread, the oldest message first. The internal notes of the support team are never part of it.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "supportRequest",
                        "in": "path",
                        "required": true,
                        "description": "The id of the request. One belonging to another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The support request object, with its messages. A request of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The support request.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always support_request. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "reference": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The reference to quote when writing to the support team, such as MON-482913."
                                                        },
                                                        "category": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the request is about: feature, billing, email, question or technical."
                                                        },
                                                        "subject": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The title the request was opened with."
                                                        },
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the request stands: to_handle when the support team has yet to answer, waiting_on_user when it has and awaits you, or solved."
                                                        },
                                                        "status_label": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The status as the application words it for the person who asked, in the language of the account."
                                                        },
                                                        "opened_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the request was opened, as a count of seconds since 1970."
                                                        },
                                                        "last_activity_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When anybody last wrote in it, the person who asked or the support team, as a count of seconds since 1970. A change of status alone does not move it."
                                                        },
                                                        "solved_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it was marked as solved, as a count of seconds since 1970, or null while it is open."
                                                        },
                                                        "messages": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The whole thread, the oldest first, without the internal notes of the support team.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One message of the thread.",
                                                                "properties": {
                                                                    "type": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Always support_message."
                                                                    },
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The id of the message."
                                                                    },
                                                                    "attributes": {
                                                                        "type": [
                                                                            "object",
                                                                            "null"
                                                                        ],
                                                                        "description": "Everything the message holds.",
                                                                        "properties": {
                                                                            "kind": {
                                                                                "type": [
                                                                                    "string",
                                                                                    "null"
                                                                                ],
                                                                                "description": "message when the person who asked wrote it, reply when the support team did. An internal note is never shown here."
                                                                            },
                                                                            "author_name": {
                                                                                "type": [
                                                                                    "string",
                                                                                    "null"
                                                                                ],
                                                                                "description": "The name of the person who wrote it."
                                                                            },
                                                                            "is_support_team": {
                                                                                "type": [
                                                                                    "boolean",
                                                                                    "null"
                                                                                ],
                                                                                "description": "Whether the support team wrote it."
                                                                            },
                                                                            "body": {
                                                                                "type": [
                                                                                    "string",
                                                                                    "null"
                                                                                ],
                                                                                "description": "What was written, as plain text."
                                                                            },
                                                                            "attachments": {
                                                                                "type": [
                                                                                    "array",
                                                                                    "null"
                                                                                ],
                                                                                "description": "The files sent with it. An empty list when there are none.",
                                                                                "items": {
                                                                                    "type": [
                                                                                        "object",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "One file.",
                                                                                    "properties": {
                                                                                        "id": {
                                                                                            "type": [
                                                                                                "string",
                                                                                                "null"
                                                                                            ],
                                                                                            "format": "uuid",
                                                                                            "description": "The id of the file, which the download address takes."
                                                                                        },
                                                                                        "name": {
                                                                                            "type": [
                                                                                                "string",
                                                                                                "null"
                                                                                            ],
                                                                                            "description": "The name the file had when it was sent."
                                                                                        },
                                                                                        "mime_type": {
                                                                                            "type": [
                                                                                                "string",
                                                                                                "null"
                                                                                            ],
                                                                                            "description": "The type of the file, such as image/png."
                                                                                        },
                                                                                        "size_in_bytes": {
                                                                                            "type": [
                                                                                                "integer",
                                                                                                "null"
                                                                                            ],
                                                                                            "description": "How large the file is, in bytes."
                                                                                        }
                                                                                    }
                                                                                }
                                                                            },
                                                                            "created_at": {
                                                                                "type": [
                                                                                    "integer",
                                                                                    "null"
                                                                                ],
                                                                                "description": "When it was written, as a count of seconds since 1970."
                                                                            }
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "support_request",
                                        "id": "7c1e4a92-5b3d-4f08-a6e1-93d2c8b05f17",
                                        "attributes": {
                                            "reference": "MON-482913",
                                            "category": "question",
                                            "subject": "My conference room reminder never arrived",
                                            "status": "waiting_on_user",
                                            "status_label": "Reply from support",
                                            "opened_at": 1791547200,
                                            "last_activity_at": 1791550800,
                                            "solved_at": null,
                                            "messages": [
                                                {
                                                    "type": "support_message",
                                                    "id": "e5a90b36-1c7d-4284-b9f3-0d6a82c471e9",
                                                    "attributes": {
                                                        "kind": "message",
                                                        "author_name": "Michael Scott",
                                                        "is_support_team": false,
                                                        "body": "I booked the conference room for the quarterly meeting, but the reminder never arrived. Dwight says it is a conspiracy.",
                                                        "attachments": [
                                                            {
                                                                "id": "b36f0d8e-47a1-4c92-95e8-1a2d7c63f0b4",
                                                                "name": "conference-room-booking.png",
                                                                "mime_type": "image/png",
                                                                "size_in_bytes": 245760
                                                            }
                                                        ],
                                                        "created_at": 1791547200
                                                    }
                                                },
                                                {
                                                    "type": "support_message",
                                                    "id": "2f8d6c14-a093-4b75-8e21-c5b7094d3a68",
                                                    "attributes": {
                                                        "kind": "reply",
                                                        "author_name": "Jim Halpert",
                                                        "is_support_team": true,
                                                        "body": "Hi Michael. The reminder was set for a time that had already passed, so it was skipped. We have moved it to tomorrow at nine.",
                                                        "attachments": [],
                                                        "created_at": 1791550800
                                                    }
                                                }
                                            ]
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/support-requests/7c1e4a92-5b3d-4f08-a6e1-93d2c8b05f17"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "support-requests-show-query",
                "tags": [
                    "Support requests"
                ],
                "summary": "Get a support request",
                "description": "Return one support request with its whole thread, the oldest message first. The internal notes of the support team are never part of it.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "supportRequest",
                        "in": "path",
                        "required": true,
                        "description": "The id of the request. One belonging to another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The support request object, with its messages. A request of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The support request.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always support_request. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "reference": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The reference to quote when writing to the support team, such as MON-482913."
                                                        },
                                                        "category": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the request is about: feature, billing, email, question or technical."
                                                        },
                                                        "subject": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The title the request was opened with."
                                                        },
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the request stands: to_handle when the support team has yet to answer, waiting_on_user when it has and awaits you, or solved."
                                                        },
                                                        "status_label": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The status as the application words it for the person who asked, in the language of the account."
                                                        },
                                                        "opened_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the request was opened, as a count of seconds since 1970."
                                                        },
                                                        "last_activity_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When anybody last wrote in it, the person who asked or the support team, as a count of seconds since 1970. A change of status alone does not move it."
                                                        },
                                                        "solved_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it was marked as solved, as a count of seconds since 1970, or null while it is open."
                                                        },
                                                        "messages": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The whole thread, the oldest first, without the internal notes of the support team.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One message of the thread.",
                                                                "properties": {
                                                                    "type": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Always support_message."
                                                                    },
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The id of the message."
                                                                    },
                                                                    "attributes": {
                                                                        "type": [
                                                                            "object",
                                                                            "null"
                                                                        ],
                                                                        "description": "Everything the message holds.",
                                                                        "properties": {
                                                                            "kind": {
                                                                                "type": [
                                                                                    "string",
                                                                                    "null"
                                                                                ],
                                                                                "description": "message when the person who asked wrote it, reply when the support team did. An internal note is never shown here."
                                                                            },
                                                                            "author_name": {
                                                                                "type": [
                                                                                    "string",
                                                                                    "null"
                                                                                ],
                                                                                "description": "The name of the person who wrote it."
                                                                            },
                                                                            "is_support_team": {
                                                                                "type": [
                                                                                    "boolean",
                                                                                    "null"
                                                                                ],
                                                                                "description": "Whether the support team wrote it."
                                                                            },
                                                                            "body": {
                                                                                "type": [
                                                                                    "string",
                                                                                    "null"
                                                                                ],
                                                                                "description": "What was written, as plain text."
                                                                            },
                                                                            "attachments": {
                                                                                "type": [
                                                                                    "array",
                                                                                    "null"
                                                                                ],
                                                                                "description": "The files sent with it. An empty list when there are none.",
                                                                                "items": {
                                                                                    "type": [
                                                                                        "object",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "One file.",
                                                                                    "properties": {
                                                                                        "id": {
                                                                                            "type": [
                                                                                                "string",
                                                                                                "null"
                                                                                            ],
                                                                                            "format": "uuid",
                                                                                            "description": "The id of the file, which the download address takes."
                                                                                        },
                                                                                        "name": {
                                                                                            "type": [
                                                                                                "string",
                                                                                                "null"
                                                                                            ],
                                                                                            "description": "The name the file had when it was sent."
                                                                                        },
                                                                                        "mime_type": {
                                                                                            "type": [
                                                                                                "string",
                                                                                                "null"
                                                                                            ],
                                                                                            "description": "The type of the file, such as image/png."
                                                                                        },
                                                                                        "size_in_bytes": {
                                                                                            "type": [
                                                                                                "integer",
                                                                                                "null"
                                                                                            ],
                                                                                            "description": "How large the file is, in bytes."
                                                                                        }
                                                                                    }
                                                                                }
                                                                            },
                                                                            "created_at": {
                                                                                "type": [
                                                                                    "integer",
                                                                                    "null"
                                                                                ],
                                                                                "description": "When it was written, as a count of seconds since 1970."
                                                                            }
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "support_request",
                                        "id": "7c1e4a92-5b3d-4f08-a6e1-93d2c8b05f17",
                                        "attributes": {
                                            "reference": "MON-482913",
                                            "category": "question",
                                            "subject": "My conference room reminder never arrived",
                                            "status": "waiting_on_user",
                                            "status_label": "Reply from support",
                                            "opened_at": 1791547200,
                                            "last_activity_at": 1791550800,
                                            "solved_at": null,
                                            "messages": [
                                                {
                                                    "type": "support_message",
                                                    "id": "e5a90b36-1c7d-4284-b9f3-0d6a82c471e9",
                                                    "attributes": {
                                                        "kind": "message",
                                                        "author_name": "Michael Scott",
                                                        "is_support_team": false,
                                                        "body": "I booked the conference room for the quarterly meeting, but the reminder never arrived. Dwight says it is a conspiracy.",
                                                        "attachments": [
                                                            {
                                                                "id": "b36f0d8e-47a1-4c92-95e8-1a2d7c63f0b4",
                                                                "name": "conference-room-booking.png",
                                                                "mime_type": "image/png",
                                                                "size_in_bytes": 245760
                                                            }
                                                        ],
                                                        "created_at": 1791547200
                                                    }
                                                },
                                                {
                                                    "type": "support_message",
                                                    "id": "2f8d6c14-a093-4b75-8e21-c5b7094d3a68",
                                                    "attributes": {
                                                        "kind": "reply",
                                                        "author_name": "Jim Halpert",
                                                        "is_support_team": true,
                                                        "body": "Hi Michael. The reminder was set for a time that had already passed, so it was skipped. We have moved it to tomorrow at nine.",
                                                        "attachments": [],
                                                        "created_at": 1791550800
                                                    }
                                                }
                                            ]
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/support-requests/7c1e4a92-5b3d-4f08-a6e1-93d2c8b05f17"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/support-requests/{supportRequest}/messages": {
            "post": {
                "operationId": "support-request-messages-create",
                "tags": [
                    "Support requests"
                ],
                "summary": "Write to the support team",
                "description": "Add a message to a request you opened. Whatever its status, including solved, the request goes back to to_handle.\n\nFiles are sent as multipart form data, in a field called files that is repeated once per file. At most 5 files, each at most 10 MB, of the types jpg, jpeg, png, gif, webp, heic, pdf, txt and log. A file that breaks any of these answers 422 on files or on files.0, files.1 and so on, and nothing is kept.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "supportRequest",
                        "in": "path",
                        "required": true,
                        "description": "The id of the request. One belonging to another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "multipart/form-data": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "body": {
                                        "type": "string",
                                        "description": "What you want to say, up to 20,000 characters. A body left empty answers 422."
                                    },
                                    "files": {
                                        "type": "string",
                                        "format": "binary",
                                        "description": "Files to send with the message. Repeat the field once per file, up to 5."
                                    }
                                },
                                "required": [
                                    "body"
                                ]
                            },
                            "example": {
                                "body": "Thank you, Jim. Could you also move the one for the Scranton Business Park meeting?"
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The message object that was written. A request of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The message.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always support_message."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of the message."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the message holds.",
                                                    "properties": {
                                                        "kind": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "message when the person who asked wrote it, reply when the support team did. An internal note is never shown here."
                                                        },
                                                        "author_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The name of the person who wrote it."
                                                        },
                                                        "is_support_team": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the support team wrote it."
                                                        },
                                                        "body": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What was written, as plain text."
                                                        },
                                                        "attachments": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The files sent with it. An empty list when there are none.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One file.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the file, which the download address takes."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name the file had when it was sent."
                                                                    },
                                                                    "mime_type": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The type of the file, such as image/png."
                                                                    },
                                                                    "size_in_bytes": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "How large the file is, in bytes."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it was written, as a count of seconds since 1970."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "support_message",
                                        "id": "e5a90b36-1c7d-4284-b9f3-0d6a82c471e9",
                                        "attributes": {
                                            "kind": "message",
                                            "author_name": "Michael Scott",
                                            "is_support_team": false,
                                            "body": "Thank you, Jim. Could you also move the one for the Scranton Business Park meeting?",
                                            "attachments": [
                                                {
                                                    "id": "b36f0d8e-47a1-4c92-95e8-1a2d7c63f0b4",
                                                    "name": "conference-room-booking.png",
                                                    "mime_type": "image/png",
                                                    "size_in_bytes": 245760
                                                }
                                            ],
                                            "created_at": 1791554400
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/support-requests/{supportRequest}/solution": {
            "post": {
                "operationId": "support-request-solution-create",
                "tags": [
                    "Support requests"
                ],
                "summary": "Mark a support request as solved",
                "description": "Tell the support team the request needs nothing more. Its status becomes solved. Writing to it again reopens it.\n\nA request that is already solved answers 422 on status with the message This request is already solved.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "supportRequest",
                        "in": "path",
                        "required": true,
                        "description": "The id of the request. One belonging to another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The support request object as it stands now, without its messages. A request of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The support request.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always support_request. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "reference": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The reference to quote when writing to the support team, such as MON-482913."
                                                        },
                                                        "category": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the request is about: feature, billing, email, question or technical."
                                                        },
                                                        "subject": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The title the request was opened with."
                                                        },
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the request stands: to_handle when the support team has yet to answer, waiting_on_user when it has and awaits you, or solved."
                                                        },
                                                        "status_label": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The status as the application words it for the person who asked, in the language of the account."
                                                        },
                                                        "opened_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the request was opened, as a count of seconds since 1970."
                                                        },
                                                        "last_activity_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When anybody last wrote in it, the person who asked or the support team, as a count of seconds since 1970. A change of status alone does not move it."
                                                        },
                                                        "solved_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it was marked as solved, as a count of seconds since 1970, or null while it is open."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "support_request",
                                        "id": "7c1e4a92-5b3d-4f08-a6e1-93d2c8b05f17",
                                        "attributes": {
                                            "reference": "MON-482913",
                                            "category": "question",
                                            "subject": "My conference room reminder never arrived",
                                            "status": "solved",
                                            "status_label": "Solved",
                                            "opened_at": 1791547200,
                                            "last_activity_at": 1791558000,
                                            "solved_at": 1791558000
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/support-requests/7c1e4a92-5b3d-4f08-a6e1-93d2c8b05f17"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/support-requests/{supportRequest}/attachments/{attachment}/content": {
            "get": {
                "operationId": "support-request-attachments-content-show",
                "tags": [
                    "Support requests"
                ],
                "summary": "Download a file of a support request",
                "description": "Return a file sent with a message of the request, byte for byte.\n\nThis endpoint does not answer in JSON. The body is the file, sent as a download with the type and the name it was uploaded with. The id of the file is the id found in the attachments of a message.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "supportRequest",
                        "in": "path",
                        "required": true,
                        "description": "The id of the request. One belonging to another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "attachment",
                        "in": "path",
                        "required": true,
                        "description": "The id of the file. One sent with an internal note, one belonging to another request, or one whose content is no longer stored answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The file. A request of another account answers 404.",
                        "content": {
                            "application/octet-stream": {
                                "schema": {
                                    "type": "string"
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "support-request-attachments-content-show-query",
                "tags": [
                    "Support requests"
                ],
                "summary": "Download a file of a support request",
                "description": "Return a file sent with a message of the request, byte for byte.\n\nThis endpoint does not answer in JSON. The body is the file, sent as a download with the type and the name it was uploaded with. The id of the file is the id found in the attachments of a message.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "supportRequest",
                        "in": "path",
                        "required": true,
                        "description": "The id of the request. One belonging to another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "attachment",
                        "in": "path",
                        "required": true,
                        "description": "The id of the file. One sent with an internal note, one belonging to another request, or one whose content is no longer stored answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The file. A request of another account answers 404.",
                        "content": {
                            "application/octet-stream": {
                                "schema": {
                                    "type": "string"
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/knowledge/folders": {
            "get": {
                "operationId": "knowledge-folders-index",
                "tags": [
                    "Knowledge folders"
                ],
                "summary": "List the Knowledge of a vault",
                "description": "List every folder of a vault's Knowledge in its order, each with the ids and titles of its notes and lists.\n\nIt is the table of contents of the vault's Knowledge. Read a note or a list through its own endpoint.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Every knowledge folder object of the vault, or an empty list. A vault of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "Every folder of the vault, whole rather than a page at a time.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One knowledge folder.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always knowledge_folder."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of the folder, which every address naming it takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the folder holds.",
                                                        "properties": {
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the folder is called."
                                                            },
                                                            "position": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "Where the folder stands among the folders of the vault, from 1."
                                                            },
                                                            "note_count": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How many notes the folder holds."
                                                            },
                                                            "list_count": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How many lists the folder holds."
                                                            },
                                                            "notes": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "The notes the folder holds.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One note.",
                                                                    "properties": {
                                                                        "id": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "format": "uuid",
                                                                            "description": "The id of the note, which the notes endpoints take."
                                                                        },
                                                                        "title": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The title of the note."
                                                                        }
                                                                    }
                                                                }
                                                            },
                                                            "lists": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "The lists the folder holds.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One list.",
                                                                    "properties": {
                                                                        "id": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "format": "uuid",
                                                                            "description": "The id of the list, which the lists endpoints take."
                                                                        },
                                                                        "title": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The title of the list."
                                                                        }
                                                                    }
                                                                }
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the folder was added, as a count of seconds since 1970."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds, or null."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find the folder. A folder is not read on its own, so it has no address of its own.",
                                                        "properties": {
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The Knowledge screen of the vault in the application, which opens for somebody signed in rather than for a key."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "knowledge_folder",
                                            "id": "2b7e4c91-0d5a-4f38-9c16-8e3a7f1b5d24",
                                            "attributes": {
                                                "name": "Office",
                                                "position": 1,
                                                "note_count": 1,
                                                "list_count": 1,
                                                "notes": [
                                                    {
                                                        "id": "7a2d9e4f-1c63-4b85-9f07-3e6c8a1d5b92",
                                                        "title": "Dundies speech"
                                                    }
                                                ],
                                                "lists": [
                                                    {
                                                        "id": "e94b1c37-6a28-4d50-8b3f-2c7e9a4d1f68",
                                                        "title": "Paper clients"
                                                    }
                                                ],
                                                "created_at": 1773331200,
                                                "updated_at": 1773331200
                                            },
                                            "links": {
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/knowledge"
                                            }
                                        },
                                        {
                                            "type": "knowledge_folder",
                                            "id": "c6f13a58-4e92-4b07-a1d3-5f8e2c9b7a60",
                                            "attributes": {
                                                "name": "Warehouse",
                                                "position": 2,
                                                "note_count": 0,
                                                "list_count": 0,
                                                "notes": [],
                                                "lists": [],
                                                "created_at": 1773417600,
                                                "updated_at": 1773417600
                                            },
                                            "links": {
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/knowledge"
                                            }
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "knowledge-folders-index-query",
                "tags": [
                    "Knowledge folders"
                ],
                "summary": "List the Knowledge of a vault",
                "description": "List every folder of a vault's Knowledge in its order, each with the ids and titles of its notes and lists.\n\nIt is the table of contents of the vault's Knowledge. Read a note or a list through its own endpoint.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Every knowledge folder object of the vault, or an empty list. A vault of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "Every folder of the vault, whole rather than a page at a time.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One knowledge folder.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always knowledge_folder."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of the folder, which every address naming it takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the folder holds.",
                                                        "properties": {
                                                            "name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the folder is called."
                                                            },
                                                            "position": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "Where the folder stands among the folders of the vault, from 1."
                                                            },
                                                            "note_count": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How many notes the folder holds."
                                                            },
                                                            "list_count": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How many lists the folder holds."
                                                            },
                                                            "notes": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "The notes the folder holds.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One note.",
                                                                    "properties": {
                                                                        "id": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "format": "uuid",
                                                                            "description": "The id of the note, which the notes endpoints take."
                                                                        },
                                                                        "title": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The title of the note."
                                                                        }
                                                                    }
                                                                }
                                                            },
                                                            "lists": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "The lists the folder holds.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One list.",
                                                                    "properties": {
                                                                        "id": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "format": "uuid",
                                                                            "description": "The id of the list, which the lists endpoints take."
                                                                        },
                                                                        "title": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The title of the list."
                                                                        }
                                                                    }
                                                                }
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the folder was added, as a count of seconds since 1970."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds, or null."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find the folder. A folder is not read on its own, so it has no address of its own.",
                                                        "properties": {
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The Knowledge screen of the vault in the application, which opens for somebody signed in rather than for a key."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "knowledge_folder",
                                            "id": "2b7e4c91-0d5a-4f38-9c16-8e3a7f1b5d24",
                                            "attributes": {
                                                "name": "Office",
                                                "position": 1,
                                                "note_count": 1,
                                                "list_count": 1,
                                                "notes": [
                                                    {
                                                        "id": "7a2d9e4f-1c63-4b85-9f07-3e6c8a1d5b92",
                                                        "title": "Dundies speech"
                                                    }
                                                ],
                                                "lists": [
                                                    {
                                                        "id": "e94b1c37-6a28-4d50-8b3f-2c7e9a4d1f68",
                                                        "title": "Paper clients"
                                                    }
                                                ],
                                                "created_at": 1773331200,
                                                "updated_at": 1773331200
                                            },
                                            "links": {
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/knowledge"
                                            }
                                        },
                                        {
                                            "type": "knowledge_folder",
                                            "id": "c6f13a58-4e92-4b07-a1d3-5f8e2c9b7a60",
                                            "attributes": {
                                                "name": "Warehouse",
                                                "position": 2,
                                                "note_count": 0,
                                                "list_count": 0,
                                                "notes": [],
                                                "lists": [],
                                                "created_at": 1773417600,
                                                "updated_at": 1773417600
                                            },
                                            "links": {
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/knowledge"
                                            }
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "post": {
                "operationId": "knowledge-folders-create",
                "tags": [
                    "Knowledge folders"
                ],
                "summary": "Add a folder",
                "description": "Add a folder to a vault's Knowledge, after the folders already there.\n\nThe change is written to the account log.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "description": "What the folder is called, up to 255 characters. Markup is stripped, and a name left empty once it is stripped is refused with “Give the folder a name.”"
                                    }
                                },
                                "required": [
                                    "name"
                                ]
                            },
                            "example": {
                                "name": "Warehouse"
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The knowledge folder object that was added.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The knowledge folder, which holds nothing yet, so its notes and lists are empty.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always knowledge_folder."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of the folder, which every address naming it takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the folder holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the folder is called."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the folder stands among the folders of the vault, from 1."
                                                        },
                                                        "note_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many notes the folder holds."
                                                        },
                                                        "list_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many lists the folder holds."
                                                        },
                                                        "notes": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The notes the folder holds."
                                                        },
                                                        "lists": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The lists the folder holds."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the folder was added, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find the folder. A folder is not read on its own, so it has no address of its own.",
                                                    "properties": {
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The Knowledge screen of the vault in the application, which opens for somebody signed in rather than for a key."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "knowledge_folder",
                                        "id": "c6f13a58-4e92-4b07-a1d3-5f8e2c9b7a60",
                                        "attributes": {
                                            "name": "Warehouse",
                                            "position": 2,
                                            "note_count": 0,
                                            "list_count": 0,
                                            "notes": [],
                                            "lists": [],
                                            "created_at": 1773417600,
                                            "updated_at": 1773417600
                                        },
                                        "links": {
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/knowledge"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/knowledge/folders/{folder}": {
            "put": {
                "operationId": "knowledge-folders-update",
                "tags": [
                    "Knowledge folders"
                ],
                "summary": "Rename or move a folder",
                "description": "Rename a folder, move it among the folders of the vault, or both.\n\nA field left out keeps its value, and a name left empty once markup is stripped keeps the one the folder had. The other folders shift so the positions run from 1 without a gap.\n\nThe change is written to the account log.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "folder",
                        "in": "path",
                        "required": true,
                        "description": "The id of the folder. A folder of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "description": "The new name, up to 255 characters."
                                    },
                                    "position": {
                                        "type": "integer",
                                        "description": "Where the folder goes, 1 for first. A number past the end puts it last."
                                    }
                                }
                            },
                            "example": {
                                "name": "Office",
                                "position": 1
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The knowledge folder object as it now reads. A folder of another vault or of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The knowledge folder.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always knowledge_folder."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of the folder, which every address naming it takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the folder holds.",
                                                    "properties": {
                                                        "name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the folder is called."
                                                        },
                                                        "position": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "Where the folder stands among the folders of the vault, from 1."
                                                        },
                                                        "note_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many notes the folder holds."
                                                        },
                                                        "list_count": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "How many lists the folder holds."
                                                        },
                                                        "notes": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The notes the folder holds.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One note.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the note, which the notes endpoints take."
                                                                    },
                                                                    "title": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The title of the note."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "lists": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The lists the folder holds.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One list.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the list, which the lists endpoints take."
                                                                    },
                                                                    "title": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The title of the list."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the folder was added, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds, or null."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find the folder. A folder is not read on its own, so it has no address of its own.",
                                                    "properties": {
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The Knowledge screen of the vault in the application, which opens for somebody signed in rather than for a key."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "knowledge_folder",
                                        "id": "2b7e4c91-0d5a-4f38-9c16-8e3a7f1b5d24",
                                        "attributes": {
                                            "name": "Office",
                                            "position": 1,
                                            "note_count": 1,
                                            "list_count": 1,
                                            "notes": [
                                                {
                                                    "id": "7a2d9e4f-1c63-4b85-9f07-3e6c8a1d5b92",
                                                    "title": "Dundies speech"
                                                }
                                            ],
                                            "lists": [
                                                {
                                                    "id": "e94b1c37-6a28-4d50-8b3f-2c7e9a4d1f68",
                                                    "title": "Paper clients"
                                                }
                                            ],
                                            "created_at": 1773331200,
                                            "updated_at": 1773331200
                                        },
                                        "links": {
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/knowledge"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "delete": {
                "operationId": "knowledge-folders-destroy",
                "tags": [
                    "Knowledge folders"
                ],
                "summary": "Delete a folder",
                "description": "Delete a folder of a vault's Knowledge, moving its notes and lists to another folder or deleting them with it.\n\nName another folder of the same vault as move_to to keep the notes and lists. Without it they are deleted for good with the folder.\n\nThe last folder of a vault cannot be deleted, and is refused with 422 and “The last folder cannot be deleted. Knowledge needs at least one.”\n\nThe change is written to the account log.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "folder",
                        "in": "path",
                        "required": true,
                        "description": "The id of the folder. A folder of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "move_to": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "The id of another folder of the vault, to move the notes and lists to. A folder of another vault answers 404, and the folder being deleted answers 422."
                                    }
                                }
                            },
                            "example": {
                                "move_to": "2b7e4c91-0d5a-4f38-9c16-8e3a7f1b5d24"
                            }
                        }
                    }
                },
                "responses": {
                    "204": {
                        "description": "Nothing. A folder of another vault or of another account answers 404."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/admin/support-requests": {
            "get": {
                "operationId": "admin-support-requests-index",
                "tags": [
                    "Support administration"
                ],
                "summary": "List support requests of the instance",
                "description": "List the support requests of every account, the oldest first, 50 to a page. The thread, the account facts and the status changes are left out of a list. Read one request to get them.\n\nOnly an administrator of this instance can use these endpoints, and only with an API key that carries the administration scope by name. Anybody else, including an administrator whose key does not carry it, gets 404 as though the endpoint did not exist.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "view",
                        "in": "query",
                        "required": false,
                        "description": "Which requests to list: to_handle, waiting_on_user, solved or all. Any other value is taken as to_handle.",
                        "schema": {
                            "type": "string",
                            "default": "to_handle"
                        }
                    },
                    {
                        "name": "q",
                        "in": "query",
                        "required": false,
                        "description": "Keep only the requests that mention this text.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "category",
                        "in": "query",
                        "required": false,
                        "description": "Keep only one category: feature, billing, email, question or technical.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "user",
                        "in": "query",
                        "required": false,
                        "description": "Keep only the requests of the user with this id.",
                        "schema": {
                            "type": "integer"
                        }
                    },
                    {
                        "name": "age",
                        "in": "query",
                        "required": false,
                        "description": "Keep only the requests of one age: day for under 24 hours, week for 1 to 7 days, old for older than 7 days.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to answer with.",
                        "schema": {
                            "type": "integer",
                            "default": 1
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of support request objects, how many there are in all, and in meta.counts how many each view holds.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The support requests on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One support request.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always support_request. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "reference": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The reference the person quotes when writing to the support team, such as MON-482913."
                                                            },
                                                            "account_id": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "The account the request was opened from."
                                                            },
                                                            "user": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "Who asked.",
                                                                "properties": {
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name of the person who opened the request, or null once their user is deleted."
                                                                    },
                                                                    "email": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Where replies are emailed, or null once their user is deleted."
                                                                    }
                                                                }
                                                            },
                                                            "category": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the request is about: feature, billing, email, question or technical."
                                                            },
                                                            "subject": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The title the request was opened with."
                                                            },
                                                            "status": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "to_handle when the person is waiting for an answer, waiting_on_user when the team is, or solved."
                                                            },
                                                            "status_label": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The status as the administrators read it, in the language of the signed in administrator."
                                                            },
                                                            "application_version": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The version of the application the request was opened from."
                                                            },
                                                            "locale": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The language the person was using when they opened it."
                                                            },
                                                            "opened_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the request was opened, as a count of seconds since 1970."
                                                            },
                                                            "last_activity_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When anybody last wrote in it, the person who asked or the support team, as a count of seconds since 1970. A change of status alone does not move it."
                                                            },
                                                            "solved_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it was marked as solved, as a count of seconds since 1970, or null while it is open."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "support_request",
                                            "id": "7c1e4a92-5b3d-4f08-a6e1-93d2c8b05f17",
                                            "attributes": {
                                                "reference": "MON-482913",
                                                "account_id": 12,
                                                "user": {
                                                    "name": "Michael Scott",
                                                    "email": "michael.scott@dundermifflin.test"
                                                },
                                                "category": "question",
                                                "subject": "My conference room reminder never arrived",
                                                "status": "waiting_on_user",
                                                "status_label": "Waiting on the user",
                                                "application_version": "5.0.0",
                                                "locale": "en",
                                                "opened_at": 1791547200,
                                                "last_activity_at": 1791550800,
                                                "solved_at": null
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/admin/support-requests/7c1e4a92-5b3d-4f08-a6e1-93d2c8b05f17"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 50,
                                        "total": 1,
                                        "counts": {
                                            "to_handle": 0,
                                            "waiting_on_user": 1,
                                            "solved": 0,
                                            "all": 1
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "admin-support-requests-index-query",
                "tags": [
                    "Support administration"
                ],
                "summary": "List support requests of the instance",
                "description": "List the support requests of every account, the oldest first, 50 to a page. The thread, the account facts and the status changes are left out of a list. Read one request to get them.\n\nOnly an administrator of this instance can use these endpoints, and only with an API key that carries the administration scope by name. Anybody else, including an administrator whose key does not carry it, gets 404 as though the endpoint did not exist.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "view": {
                                        "type": "string",
                                        "default": "to_handle",
                                        "description": "Which requests to list: to_handle, waiting_on_user, solved or all. Any other value is taken as to_handle."
                                    },
                                    "q": {
                                        "type": "string",
                                        "description": "Keep only the requests that mention this text."
                                    },
                                    "category": {
                                        "type": "string",
                                        "description": "Keep only one category: feature, billing, email, question or technical."
                                    },
                                    "user": {
                                        "type": "integer",
                                        "description": "Keep only the requests of the user with this id."
                                    },
                                    "age": {
                                        "type": "string",
                                        "description": "Keep only the requests of one age: day for under 24 hours, week for 1 to 7 days, old for older than 7 days."
                                    },
                                    "page": {
                                        "type": "integer",
                                        "default": 1,
                                        "description": "Which page to answer with."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "A page of support request objects, how many there are in all, and in meta.counts how many each view holds.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The support requests on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One support request.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always support_request. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "reference": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The reference the person quotes when writing to the support team, such as MON-482913."
                                                            },
                                                            "account_id": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "The account the request was opened from."
                                                            },
                                                            "user": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "Who asked.",
                                                                "properties": {
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name of the person who opened the request, or null once their user is deleted."
                                                                    },
                                                                    "email": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Where replies are emailed, or null once their user is deleted."
                                                                    }
                                                                }
                                                            },
                                                            "category": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the request is about: feature, billing, email, question or technical."
                                                            },
                                                            "subject": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The title the request was opened with."
                                                            },
                                                            "status": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "to_handle when the person is waiting for an answer, waiting_on_user when the team is, or solved."
                                                            },
                                                            "status_label": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The status as the administrators read it, in the language of the signed in administrator."
                                                            },
                                                            "application_version": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The version of the application the request was opened from."
                                                            },
                                                            "locale": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The language the person was using when they opened it."
                                                            },
                                                            "opened_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the request was opened, as a count of seconds since 1970."
                                                            },
                                                            "last_activity_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When anybody last wrote in it, the person who asked or the support team, as a count of seconds since 1970. A change of status alone does not move it."
                                                            },
                                                            "solved_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it was marked as solved, as a count of seconds since 1970, or null while it is open."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "support_request",
                                            "id": "7c1e4a92-5b3d-4f08-a6e1-93d2c8b05f17",
                                            "attributes": {
                                                "reference": "MON-482913",
                                                "account_id": 12,
                                                "user": {
                                                    "name": "Michael Scott",
                                                    "email": "michael.scott@dundermifflin.test"
                                                },
                                                "category": "question",
                                                "subject": "My conference room reminder never arrived",
                                                "status": "waiting_on_user",
                                                "status_label": "Waiting on the user",
                                                "application_version": "5.0.0",
                                                "locale": "en",
                                                "opened_at": 1791547200,
                                                "last_activity_at": 1791550800,
                                                "solved_at": null
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/admin/support-requests/7c1e4a92-5b3d-4f08-a6e1-93d2c8b05f17"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 50,
                                        "total": 1,
                                        "counts": {
                                            "to_handle": 0,
                                            "waiting_on_user": 1,
                                            "solved": 0,
                                            "all": 1
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/admin/support-requests/{supportRequest}": {
            "get": {
                "operationId": "admin-support-requests-show",
                "tags": [
                    "Support administration"
                ],
                "summary": "Get a support request of the instance",
                "description": "Return one support request of any account, with the whole thread including the internal notes, a few facts about the account, and how the status moved.\n\nOnly an administrator of this instance can use these endpoints, and only with an API key that carries the administration scope by name. Anybody else, including an administrator whose key does not carry it, gets 404 as though the endpoint did not exist.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "supportRequest",
                        "in": "path",
                        "required": true,
                        "description": "The id of the request, of any account on the instance.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The support request object. An id that matches no request answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The support request.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always support_request. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "reference": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The reference the person quotes when writing to the support team, such as MON-482913."
                                                        },
                                                        "account_id": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The account the request was opened from."
                                                        },
                                                        "user": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "Who asked.",
                                                            "properties": {
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The name of the person who opened the request, or null once their user is deleted."
                                                                },
                                                                "email": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "Where replies are emailed, or null once their user is deleted."
                                                                }
                                                            }
                                                        },
                                                        "category": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the request is about: feature, billing, email, question or technical."
                                                        },
                                                        "subject": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The title the request was opened with."
                                                        },
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "to_handle when the person is waiting for an answer, waiting_on_user when the team is, or solved."
                                                        },
                                                        "status_label": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The status as the administrators read it, in the language of the signed in administrator."
                                                        },
                                                        "application_version": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The version of the application the request was opened from."
                                                        },
                                                        "locale": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The language the person was using when they opened it."
                                                        },
                                                        "opened_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the request was opened, as a count of seconds since 1970."
                                                        },
                                                        "last_activity_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When anybody last wrote in it, the person who asked or the support team, as a count of seconds since 1970. A change of status alone does not move it."
                                                        },
                                                        "solved_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it was marked as solved, as a count of seconds since 1970, or null while it is open."
                                                        },
                                                        "messages": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The whole thread, the oldest first, with the internal notes.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One message of the thread.",
                                                                "properties": {
                                                                    "type": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Always support_message."
                                                                    },
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The id of the message."
                                                                    },
                                                                    "attributes": {
                                                                        "type": [
                                                                            "object",
                                                                            "null"
                                                                        ],
                                                                        "description": "Everything the message holds.",
                                                                        "properties": {
                                                                            "kind": {
                                                                                "type": [
                                                                                    "string",
                                                                                    "null"
                                                                                ],
                                                                                "description": "message when the person wrote it, reply when an administrator answered them, note when an administrator wrote it for the team alone."
                                                                            },
                                                                            "author_name": {
                                                                                "type": [
                                                                                    "string",
                                                                                    "null"
                                                                                ],
                                                                                "description": "The name of the person who wrote it."
                                                                            },
                                                                            "is_support_team": {
                                                                                "type": [
                                                                                    "boolean",
                                                                                    "null"
                                                                                ],
                                                                                "description": "Whether an administrator wrote it."
                                                                            },
                                                                            "body": {
                                                                                "type": [
                                                                                    "string",
                                                                                    "null"
                                                                                ],
                                                                                "description": "What was written, as plain text."
                                                                            },
                                                                            "attachments": {
                                                                                "type": [
                                                                                    "array",
                                                                                    "null"
                                                                                ],
                                                                                "description": "The files sent with it. An empty list when there are none, which is always the case for a reply or a note written through this API.",
                                                                                "items": {
                                                                                    "type": [
                                                                                        "object",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "One file.",
                                                                                    "properties": {
                                                                                        "id": {
                                                                                            "type": [
                                                                                                "string",
                                                                                                "null"
                                                                                            ],
                                                                                            "format": "uuid",
                                                                                            "description": "The id of the file."
                                                                                        },
                                                                                        "name": {
                                                                                            "type": [
                                                                                                "string",
                                                                                                "null"
                                                                                            ],
                                                                                            "description": "The name the file had when it was sent."
                                                                                        },
                                                                                        "mime_type": {
                                                                                            "type": [
                                                                                                "string",
                                                                                                "null"
                                                                                            ],
                                                                                            "description": "The type of the file, such as image/png."
                                                                                        },
                                                                                        "size_in_bytes": {
                                                                                            "type": [
                                                                                                "integer",
                                                                                                "null"
                                                                                            ],
                                                                                            "description": "How large the file is, in bytes."
                                                                                        }
                                                                                    }
                                                                                }
                                                                            },
                                                                            "created_at": {
                                                                                "type": [
                                                                                    "integer",
                                                                                    "null"
                                                                                ],
                                                                                "description": "When it was written, as a count of seconds since 1970."
                                                                            }
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "context": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "A few facts about the account, to answer with.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One fact.",
                                                                "properties": {
                                                                    "label": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the fact is about, such as Version."
                                                                    },
                                                                    "value": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The fact."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "status_changes": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "How the status moved, the oldest first.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One change of status.",
                                                                "properties": {
                                                                    "from": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The status it left, or null for the change that opened the request."
                                                                    },
                                                                    "to": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The status it took."
                                                                    },
                                                                    "by": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name of who changed it."
                                                                    },
                                                                    "at": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "When, as a count of seconds since 1970."
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "support_request",
                                        "id": "7c1e4a92-5b3d-4f08-a6e1-93d2c8b05f17",
                                        "attributes": {
                                            "reference": "MON-482913",
                                            "account_id": 12,
                                            "user": {
                                                "name": "Michael Scott",
                                                "email": "michael.scott@dundermifflin.test"
                                            },
                                            "category": "question",
                                            "subject": "My conference room reminder never arrived",
                                            "status": "waiting_on_user",
                                            "status_label": "Waiting on the user",
                                            "application_version": "5.0.0",
                                            "locale": "en",
                                            "opened_at": 1791547200,
                                            "last_activity_at": 1791550800,
                                            "solved_at": null,
                                            "messages": [
                                                {
                                                    "type": "support_message",
                                                    "id": "e5a90b36-1c7d-4284-b9f3-0d6a82c471e9",
                                                    "attributes": {
                                                        "kind": "message",
                                                        "author_name": "Michael Scott",
                                                        "is_support_team": false,
                                                        "body": "I booked the conference room for the quarterly meeting, but the reminder never arrived. Dwight says it is a conspiracy.",
                                                        "attachments": [
                                                            {
                                                                "id": "b36f0d8e-47a1-4c92-95e8-1a2d7c63f0b4",
                                                                "name": "conference-room-booking.png",
                                                                "mime_type": "image/png",
                                                                "size_in_bytes": 245760
                                                            }
                                                        ],
                                                        "created_at": 1791547200
                                                    }
                                                },
                                                {
                                                    "type": "support_message",
                                                    "id": "2f8d6c14-a093-4b75-8e21-c5b7094d3a68",
                                                    "attributes": {
                                                        "kind": "reply",
                                                        "author_name": "Jim Halpert",
                                                        "is_support_team": true,
                                                        "body": "Hi Michael. The reminder was set for a time that had already passed, so it was skipped. We have moved it to tomorrow at nine.",
                                                        "attachments": [],
                                                        "created_at": 1791550800
                                                    }
                                                },
                                                {
                                                    "type": "support_message",
                                                    "id": "8a41c7e5-d209-4b3f-b6a8-5e90f13d7c24",
                                                    "attributes": {
                                                        "kind": "note",
                                                        "author_name": "Jim Halpert",
                                                        "is_support_team": true,
                                                        "body": "Same account as the ticket about the birthday reminders. Check with Pam before closing.",
                                                        "attachments": [],
                                                        "created_at": 1791551400
                                                    }
                                                }
                                            ],
                                            "context": [
                                                {
                                                    "label": "Account",
                                                    "value": "#12"
                                                },
                                                {
                                                    "label": "Access",
                                                    "value": "Free plan"
                                                },
                                                {
                                                    "label": "Language",
                                                    "value": "English"
                                                },
                                                {
                                                    "label": "Version",
                                                    "value": "5.0.0"
                                                },
                                                {
                                                    "label": "Content",
                                                    "value": "1 vault, 24 contacts"
                                                },
                                                {
                                                    "label": "Signed up",
                                                    "value": "March 4, 2026"
                                                }
                                            ],
                                            "status_changes": [
                                                {
                                                    "from": null,
                                                    "to": "to_handle",
                                                    "by": "Michael Scott",
                                                    "at": 1791547200
                                                },
                                                {
                                                    "from": "to_handle",
                                                    "to": "waiting_on_user",
                                                    "by": "Jim Halpert",
                                                    "at": 1791550800
                                                }
                                            ]
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/admin/support-requests/7c1e4a92-5b3d-4f08-a6e1-93d2c8b05f17"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "admin-support-requests-show-query",
                "tags": [
                    "Support administration"
                ],
                "summary": "Get a support request of the instance",
                "description": "Return one support request of any account, with the whole thread including the internal notes, a few facts about the account, and how the status moved.\n\nOnly an administrator of this instance can use these endpoints, and only with an API key that carries the administration scope by name. Anybody else, including an administrator whose key does not carry it, gets 404 as though the endpoint did not exist.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "supportRequest",
                        "in": "path",
                        "required": true,
                        "description": "The id of the request, of any account on the instance.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The support request object. An id that matches no request answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The support request.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always support_request. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "reference": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The reference the person quotes when writing to the support team, such as MON-482913."
                                                        },
                                                        "account_id": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The account the request was opened from."
                                                        },
                                                        "user": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "Who asked.",
                                                            "properties": {
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The name of the person who opened the request, or null once their user is deleted."
                                                                },
                                                                "email": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "Where replies are emailed, or null once their user is deleted."
                                                                }
                                                            }
                                                        },
                                                        "category": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the request is about: feature, billing, email, question or technical."
                                                        },
                                                        "subject": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The title the request was opened with."
                                                        },
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "to_handle when the person is waiting for an answer, waiting_on_user when the team is, or solved."
                                                        },
                                                        "status_label": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The status as the administrators read it, in the language of the signed in administrator."
                                                        },
                                                        "application_version": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The version of the application the request was opened from."
                                                        },
                                                        "locale": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The language the person was using when they opened it."
                                                        },
                                                        "opened_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the request was opened, as a count of seconds since 1970."
                                                        },
                                                        "last_activity_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When anybody last wrote in it, the person who asked or the support team, as a count of seconds since 1970. A change of status alone does not move it."
                                                        },
                                                        "solved_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it was marked as solved, as a count of seconds since 1970, or null while it is open."
                                                        },
                                                        "messages": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The whole thread, the oldest first, with the internal notes.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One message of the thread.",
                                                                "properties": {
                                                                    "type": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Always support_message."
                                                                    },
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The id of the message."
                                                                    },
                                                                    "attributes": {
                                                                        "type": [
                                                                            "object",
                                                                            "null"
                                                                        ],
                                                                        "description": "Everything the message holds.",
                                                                        "properties": {
                                                                            "kind": {
                                                                                "type": [
                                                                                    "string",
                                                                                    "null"
                                                                                ],
                                                                                "description": "message when the person wrote it, reply when an administrator answered them, note when an administrator wrote it for the team alone."
                                                                            },
                                                                            "author_name": {
                                                                                "type": [
                                                                                    "string",
                                                                                    "null"
                                                                                ],
                                                                                "description": "The name of the person who wrote it."
                                                                            },
                                                                            "is_support_team": {
                                                                                "type": [
                                                                                    "boolean",
                                                                                    "null"
                                                                                ],
                                                                                "description": "Whether an administrator wrote it."
                                                                            },
                                                                            "body": {
                                                                                "type": [
                                                                                    "string",
                                                                                    "null"
                                                                                ],
                                                                                "description": "What was written, as plain text."
                                                                            },
                                                                            "attachments": {
                                                                                "type": [
                                                                                    "array",
                                                                                    "null"
                                                                                ],
                                                                                "description": "The files sent with it. An empty list when there are none, which is always the case for a reply or a note written through this API.",
                                                                                "items": {
                                                                                    "type": [
                                                                                        "object",
                                                                                        "null"
                                                                                    ],
                                                                                    "description": "One file.",
                                                                                    "properties": {
                                                                                        "id": {
                                                                                            "type": [
                                                                                                "string",
                                                                                                "null"
                                                                                            ],
                                                                                            "format": "uuid",
                                                                                            "description": "The id of the file."
                                                                                        },
                                                                                        "name": {
                                                                                            "type": [
                                                                                                "string",
                                                                                                "null"
                                                                                            ],
                                                                                            "description": "The name the file had when it was sent."
                                                                                        },
                                                                                        "mime_type": {
                                                                                            "type": [
                                                                                                "string",
                                                                                                "null"
                                                                                            ],
                                                                                            "description": "The type of the file, such as image/png."
                                                                                        },
                                                                                        "size_in_bytes": {
                                                                                            "type": [
                                                                                                "integer",
                                                                                                "null"
                                                                                            ],
                                                                                            "description": "How large the file is, in bytes."
                                                                                        }
                                                                                    }
                                                                                }
                                                                            },
                                                                            "created_at": {
                                                                                "type": [
                                                                                    "integer",
                                                                                    "null"
                                                                                ],
                                                                                "description": "When it was written, as a count of seconds since 1970."
                                                                            }
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "context": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "A few facts about the account, to answer with.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One fact.",
                                                                "properties": {
                                                                    "label": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the fact is about, such as Version."
                                                                    },
                                                                    "value": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The fact."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "status_changes": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "How the status moved, the oldest first.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One change of status.",
                                                                "properties": {
                                                                    "from": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The status it left, or null for the change that opened the request."
                                                                    },
                                                                    "to": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The status it took."
                                                                    },
                                                                    "by": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name of who changed it."
                                                                    },
                                                                    "at": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "When, as a count of seconds since 1970."
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "support_request",
                                        "id": "7c1e4a92-5b3d-4f08-a6e1-93d2c8b05f17",
                                        "attributes": {
                                            "reference": "MON-482913",
                                            "account_id": 12,
                                            "user": {
                                                "name": "Michael Scott",
                                                "email": "michael.scott@dundermifflin.test"
                                            },
                                            "category": "question",
                                            "subject": "My conference room reminder never arrived",
                                            "status": "waiting_on_user",
                                            "status_label": "Waiting on the user",
                                            "application_version": "5.0.0",
                                            "locale": "en",
                                            "opened_at": 1791547200,
                                            "last_activity_at": 1791550800,
                                            "solved_at": null,
                                            "messages": [
                                                {
                                                    "type": "support_message",
                                                    "id": "e5a90b36-1c7d-4284-b9f3-0d6a82c471e9",
                                                    "attributes": {
                                                        "kind": "message",
                                                        "author_name": "Michael Scott",
                                                        "is_support_team": false,
                                                        "body": "I booked the conference room for the quarterly meeting, but the reminder never arrived. Dwight says it is a conspiracy.",
                                                        "attachments": [
                                                            {
                                                                "id": "b36f0d8e-47a1-4c92-95e8-1a2d7c63f0b4",
                                                                "name": "conference-room-booking.png",
                                                                "mime_type": "image/png",
                                                                "size_in_bytes": 245760
                                                            }
                                                        ],
                                                        "created_at": 1791547200
                                                    }
                                                },
                                                {
                                                    "type": "support_message",
                                                    "id": "2f8d6c14-a093-4b75-8e21-c5b7094d3a68",
                                                    "attributes": {
                                                        "kind": "reply",
                                                        "author_name": "Jim Halpert",
                                                        "is_support_team": true,
                                                        "body": "Hi Michael. The reminder was set for a time that had already passed, so it was skipped. We have moved it to tomorrow at nine.",
                                                        "attachments": [],
                                                        "created_at": 1791550800
                                                    }
                                                },
                                                {
                                                    "type": "support_message",
                                                    "id": "8a41c7e5-d209-4b3f-b6a8-5e90f13d7c24",
                                                    "attributes": {
                                                        "kind": "note",
                                                        "author_name": "Jim Halpert",
                                                        "is_support_team": true,
                                                        "body": "Same account as the ticket about the birthday reminders. Check with Pam before closing.",
                                                        "attachments": [],
                                                        "created_at": 1791551400
                                                    }
                                                }
                                            ],
                                            "context": [
                                                {
                                                    "label": "Account",
                                                    "value": "#12"
                                                },
                                                {
                                                    "label": "Access",
                                                    "value": "Free plan"
                                                },
                                                {
                                                    "label": "Language",
                                                    "value": "English"
                                                },
                                                {
                                                    "label": "Version",
                                                    "value": "5.0.0"
                                                },
                                                {
                                                    "label": "Content",
                                                    "value": "1 vault, 24 contacts"
                                                },
                                                {
                                                    "label": "Signed up",
                                                    "value": "March 4, 2026"
                                                }
                                            ],
                                            "status_changes": [
                                                {
                                                    "from": null,
                                                    "to": "to_handle",
                                                    "by": "Michael Scott",
                                                    "at": 1791547200
                                                },
                                                {
                                                    "from": "to_handle",
                                                    "to": "waiting_on_user",
                                                    "by": "Jim Halpert",
                                                    "at": 1791550800
                                                }
                                            ]
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/admin/support-requests/7c1e4a92-5b3d-4f08-a6e1-93d2c8b05f17"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/admin/support-requests/{supportRequest}/replies": {
            "post": {
                "operationId": "admin-support-request-replies-create",
                "tags": [
                    "Support administration"
                ],
                "summary": "Answer a support request",
                "description": "Write an answer to the person who opened the request, and email it to them. The request takes the status you name, which is waiting_on_user when you name none.\n\nOnly an administrator of this instance can use these endpoints, and only with an API key that carries the administration scope by name. Anybody else, including an administrator whose key does not carry it, gets 404 as though the endpoint did not exist.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "supportRequest",
                        "in": "path",
                        "required": true,
                        "description": "The id of the request, of any account on the instance.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "body": {
                                        "type": "string",
                                        "description": "What to say, up to 20,000 characters. A body left empty answers 422."
                                    },
                                    "status": {
                                        "type": "string",
                                        "default": "waiting_on_user",
                                        "description": "The status the request takes once answered: to_handle, waiting_on_user or solved. Any other value answers 422 on status."
                                    }
                                },
                                "required": [
                                    "body"
                                ]
                            },
                            "example": {
                                "body": "Hi Michael. The reminder was set for a time that had already passed, so it was skipped. We have moved it to tomorrow at nine.",
                                "status": "waiting_on_user"
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The message object that was written.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The message.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always support_message."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of the message."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the message holds.",
                                                    "properties": {
                                                        "kind": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "message when the person wrote it, reply when an administrator answered them, note when an administrator wrote it for the team alone."
                                                        },
                                                        "author_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The name of the person who wrote it."
                                                        },
                                                        "is_support_team": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether an administrator wrote it."
                                                        },
                                                        "body": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What was written, as plain text."
                                                        },
                                                        "attachments": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The files sent with it. An empty list when there are none, which is always the case for a reply or a note written through this API."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it was written, as a count of seconds since 1970."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "support_message",
                                        "id": "2f8d6c14-a093-4b75-8e21-c5b7094d3a68",
                                        "attributes": {
                                            "kind": "reply",
                                            "author_name": "Jim Halpert",
                                            "is_support_team": true,
                                            "body": "Hi Michael. The reminder was set for a time that had already passed, so it was skipped. We have moved it to tomorrow at nine.",
                                            "attachments": [],
                                            "created_at": 1791550800
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/admin/support-requests/{supportRequest}/notes": {
            "post": {
                "operationId": "admin-support-request-notes-create",
                "tags": [
                    "Support administration"
                ],
                "summary": "Leave a note on a support request",
                "description": "Write a note that only the administrators read. It is never emailed and never shown to the person who asked.\n\nOnly an administrator of this instance can use these endpoints, and only with an API key that carries the administration scope by name. Anybody else, including an administrator whose key does not carry it, gets 404 as though the endpoint did not exist.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "supportRequest",
                        "in": "path",
                        "required": true,
                        "description": "The id of the request, of any account on the instance.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "body": {
                                        "type": "string",
                                        "description": "What to write, up to 20,000 characters. A body left empty answers 422."
                                    }
                                },
                                "required": [
                                    "body"
                                ]
                            },
                            "example": {
                                "body": "Same account as the ticket about the birthday reminders. Check with Pam before closing."
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The message object that was written, with a kind of note.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The message.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always support_message."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of the message."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the message holds.",
                                                    "properties": {
                                                        "kind": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "message when the person wrote it, reply when an administrator answered them, note when an administrator wrote it for the team alone."
                                                        },
                                                        "author_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The name of the person who wrote it."
                                                        },
                                                        "is_support_team": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether an administrator wrote it."
                                                        },
                                                        "body": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What was written, as plain text."
                                                        },
                                                        "attachments": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The files sent with it. An empty list when there are none, which is always the case for a reply or a note written through this API."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it was written, as a count of seconds since 1970."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "support_message",
                                        "id": "8a41c7e5-d209-4b3f-b6a8-5e90f13d7c24",
                                        "attributes": {
                                            "kind": "note",
                                            "author_name": "Jim Halpert",
                                            "is_support_team": true,
                                            "body": "Same account as the ticket about the birthday reminders. Check with Pam before closing.",
                                            "attachments": [],
                                            "created_at": 1791551400
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/admin/support-requests/{supportRequest}/status": {
            "put": {
                "operationId": "admin-support-request-status-update",
                "tags": [
                    "Support administration"
                ],
                "summary": "Change the status of a support request",
                "description": "Move a request to another status without writing to the person.\n\nOnly an administrator of this instance can use these endpoints, and only with an API key that carries the administration scope by name. Anybody else, including an administrator whose key does not carry it, gets 404 as though the endpoint did not exist.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "supportRequest",
                        "in": "path",
                        "required": true,
                        "description": "The id of the request, of any account on the instance.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "status": {
                                        "type": "string",
                                        "description": "The status to move to: to_handle, waiting_on_user or solved. Any other value answers 422 on status."
                                    }
                                },
                                "required": [
                                    "status"
                                ]
                            },
                            "example": {
                                "status": "solved"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The support request object as it stands now, without its messages and its status changes. Read the request to get them.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The support request.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always support_request. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "reference": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The reference the person quotes when writing to the support team, such as MON-482913."
                                                        },
                                                        "account_id": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The account the request was opened from."
                                                        },
                                                        "user": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "Who asked.",
                                                            "properties": {
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "The name of the person who opened the request, or null once their user is deleted."
                                                                },
                                                                "email": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "Where replies are emailed, or null once their user is deleted."
                                                                }
                                                            }
                                                        },
                                                        "category": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the request is about: feature, billing, email, question or technical."
                                                        },
                                                        "subject": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The title the request was opened with."
                                                        },
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "to_handle when the person is waiting for an answer, waiting_on_user when the team is, or solved."
                                                        },
                                                        "status_label": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The status as the administrators read it, in the language of the signed in administrator."
                                                        },
                                                        "application_version": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The version of the application the request was opened from."
                                                        },
                                                        "locale": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The language the person was using when they opened it."
                                                        },
                                                        "opened_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the request was opened, as a count of seconds since 1970."
                                                        },
                                                        "last_activity_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When anybody last wrote in it, the person who asked or the support team, as a count of seconds since 1970. A change of status alone does not move it."
                                                        },
                                                        "solved_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it was marked as solved, as a count of seconds since 1970, or null while it is open."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "support_request",
                                        "id": "7c1e4a92-5b3d-4f08-a6e1-93d2c8b05f17",
                                        "attributes": {
                                            "reference": "MON-482913",
                                            "account_id": 12,
                                            "user": {
                                                "name": "Michael Scott",
                                                "email": "michael.scott@dundermifflin.test"
                                            },
                                            "category": "question",
                                            "subject": "My conference room reminder never arrived",
                                            "status": "solved",
                                            "status_label": "Solved",
                                            "application_version": "5.0.0",
                                            "locale": "en",
                                            "opened_at": 1791547200,
                                            "last_activity_at": 1791554400,
                                            "solved_at": 1791554400
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/admin/support-requests/7c1e4a92-5b3d-4f08-a6e1-93d2c8b05f17"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/knowledge/notes": {
            "get": {
                "operationId": "knowledge-notes-index",
                "tags": [
                    "Knowledge notes"
                ],
                "summary": "List the notes of a vault",
                "description": "List the notes of a vault's Knowledge by title, without their text.\n\nA note can be long, so the list leaves its text out. Read one note to get it.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "folder",
                        "in": "query",
                        "required": false,
                        "description": "Only the notes of this folder. The id of a folder of the vault, as the knowledge folders endpoints give it. A folder of another vault answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Every knowledge note object of the vault, without its text, or an empty list. A vault of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "Every note, whole rather than a page at a time.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One knowledge note, without its text.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always knowledge_note."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of the note, which every address naming it takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "What the note is, without its text.",
                                                        "properties": {
                                                            "title": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The title of the note."
                                                            },
                                                            "folder": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The folder the note sits in.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the folder, as the knowledge folders endpoints give it."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the folder is called."
                                                                    }
                                                                }
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the note was written, as a count of seconds since 1970."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds, or null."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this note.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address the whole note is read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The note in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "knowledge_note",
                                            "id": "7a2d9e4f-1c63-4b85-9f07-3e6c8a1d5b92",
                                            "attributes": {
                                                "title": "Dundies speech",
                                                "folder": {
                                                    "id": "2b7e4c91-0d5a-4f38-9c16-8e3a7f1b5d24",
                                                    "name": "Office"
                                                },
                                                "created_at": 1773331200,
                                                "updated_at": 1773417600
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/knowledge/notes/7a2d9e4f-1c63-4b85-9f07-3e6c8a1d5b92",
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/knowledge/notes/7a2d9e4f-1c63-4b85-9f07-3e6c8a1d5b92"
                                            }
                                        },
                                        {
                                            "type": "knowledge_note",
                                            "id": "4c8e2a61-9b37-4d05-a6f1-0e3b7c9d2a58",
                                            "attributes": {
                                                "title": "Fire drill",
                                                "folder": {
                                                    "id": "2b7e4c91-0d5a-4f38-9c16-8e3a7f1b5d24",
                                                    "name": "Office"
                                                },
                                                "created_at": 1773504000,
                                                "updated_at": 1773504000
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/knowledge/notes/4c8e2a61-9b37-4d05-a6f1-0e3b7c9d2a58",
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/knowledge/notes/4c8e2a61-9b37-4d05-a6f1-0e3b7c9d2a58"
                                            }
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "knowledge-notes-index-query",
                "tags": [
                    "Knowledge notes"
                ],
                "summary": "List the notes of a vault",
                "description": "List the notes of a vault's Knowledge by title, without their text.\n\nA note can be long, so the list leaves its text out. Read one note to get it.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "folder": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "Only the notes of this folder. The id of a folder of the vault, as the knowledge folders endpoints give it. A folder of another vault answers 404."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Every knowledge note object of the vault, without its text, or an empty list. A vault of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "Every note, whole rather than a page at a time.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One knowledge note, without its text.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always knowledge_note."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of the note, which every address naming it takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "What the note is, without its text.",
                                                        "properties": {
                                                            "title": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The title of the note."
                                                            },
                                                            "folder": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The folder the note sits in.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the folder, as the knowledge folders endpoints give it."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the folder is called."
                                                                    }
                                                                }
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the note was written, as a count of seconds since 1970."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds, or null."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this note.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address the whole note is read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The note in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "knowledge_note",
                                            "id": "7a2d9e4f-1c63-4b85-9f07-3e6c8a1d5b92",
                                            "attributes": {
                                                "title": "Dundies speech",
                                                "folder": {
                                                    "id": "2b7e4c91-0d5a-4f38-9c16-8e3a7f1b5d24",
                                                    "name": "Office"
                                                },
                                                "created_at": 1773331200,
                                                "updated_at": 1773417600
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/knowledge/notes/7a2d9e4f-1c63-4b85-9f07-3e6c8a1d5b92",
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/knowledge/notes/7a2d9e4f-1c63-4b85-9f07-3e6c8a1d5b92"
                                            }
                                        },
                                        {
                                            "type": "knowledge_note",
                                            "id": "4c8e2a61-9b37-4d05-a6f1-0e3b7c9d2a58",
                                            "attributes": {
                                                "title": "Fire drill",
                                                "folder": {
                                                    "id": "2b7e4c91-0d5a-4f38-9c16-8e3a7f1b5d24",
                                                    "name": "Office"
                                                },
                                                "created_at": 1773504000,
                                                "updated_at": 1773504000
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/knowledge/notes/4c8e2a61-9b37-4d05-a6f1-0e3b7c9d2a58",
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/knowledge/notes/4c8e2a61-9b37-4d05-a6f1-0e3b7c9d2a58"
                                            }
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "post": {
                "operationId": "knowledge-notes-create",
                "tags": [
                    "Knowledge notes"
                ],
                "summary": "Write a note",
                "description": "Write a note in a vault's Knowledge.\n\nEvery field is optional. A note without a title is called “Untitled note”. Without a folder it goes to the first folder of the vault, and a vault without any folder gets one called “General” to hold it.\n\nThe change is written to the account log.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "title": {
                                        "type": "string",
                                        "description": "The title of the note, up to 255 characters. Markup is stripped."
                                    },
                                    "body": {
                                        "type": "string",
                                        "description": "The text of the note in Markdown, up to 200,000 characters: # for a heading, - for a bullet, - [ ] for a task, > for a quote, **bold**. Web addresses become links on their own."
                                    },
                                    "folder_id": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "The id of a folder of the vault, as the knowledge folders endpoints give it. A folder of another vault answers 404."
                                    }
                                }
                            },
                            "example": {
                                "title": "Dundies speech",
                                "body": "## Best dressed\nPam, again.\n\n- [x] Book Chili's\n- [ ] Engrave the trophies",
                                "folder_id": "2b7e4c91-0d5a-4f38-9c16-8e3a7f1b5d24"
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The knowledge note object that was written.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The knowledge note.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always knowledge_note. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "title": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The title of the note."
                                                        },
                                                        "folder": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The folder the note sits in.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the folder, as the knowledge folders endpoints give it."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What the folder is called."
                                                                }
                                                            }
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the note was written, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds, or null."
                                                        },
                                                        "body": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The text of the note in Markdown, exactly as written, or null. It is never drawn: raw HTML in it stays text, and the application escapes it when it shows the note."
                                                        },
                                                        "headings": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The headings of the text, from the first level to the third, in reading order.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One heading.",
                                                                "properties": {
                                                                    "text": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the heading says."
                                                                    },
                                                                    "level": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Its level, 1 to 3."
                                                                    },
                                                                    "anchor": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The anchor the application gives it, to open the note at that heading with links.web followed by # and the anchor."
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The note in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "knowledge_note",
                                        "id": "7a2d9e4f-1c63-4b85-9f07-3e6c8a1d5b92",
                                        "attributes": {
                                            "title": "Dundies speech",
                                            "body": "## Best dressed\nPam, again.\n\n- [x] Book Chili's\n- [ ] Engrave the trophies",
                                            "headings": [
                                                {
                                                    "text": "Best dressed",
                                                    "level": 2,
                                                    "anchor": "section-best-dressed"
                                                }
                                            ],
                                            "folder": {
                                                "id": "2b7e4c91-0d5a-4f38-9c16-8e3a7f1b5d24",
                                                "name": "Office"
                                            },
                                            "created_at": 1773331200,
                                            "updated_at": 1773417600
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/knowledge/notes/7a2d9e4f-1c63-4b85-9f07-3e6c8a1d5b92",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/knowledge/notes/7a2d9e4f-1c63-4b85-9f07-3e6c8a1d5b92"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/knowledge/notes/{note}": {
            "get": {
                "operationId": "knowledge-notes-show",
                "tags": [
                    "Knowledge notes"
                ],
                "summary": "Get a note",
                "description": "Retrieve one note with its text and its headings.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "note",
                        "in": "path",
                        "required": true,
                        "description": "The id of the note. A note of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A knowledge note object. A note of another vault or of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The knowledge note.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always knowledge_note. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "title": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The title of the note."
                                                        },
                                                        "folder": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The folder the note sits in.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the folder, as the knowledge folders endpoints give it."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What the folder is called."
                                                                }
                                                            }
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the note was written, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds, or null."
                                                        },
                                                        "body": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The text of the note in Markdown, exactly as written, or null. It is never drawn: raw HTML in it stays text, and the application escapes it when it shows the note."
                                                        },
                                                        "headings": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The headings of the text, from the first level to the third, in reading order.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One heading.",
                                                                "properties": {
                                                                    "text": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the heading says."
                                                                    },
                                                                    "level": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Its level, 1 to 3."
                                                                    },
                                                                    "anchor": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The anchor the application gives it, to open the note at that heading with links.web followed by # and the anchor."
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The note in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "knowledge_note",
                                        "id": "7a2d9e4f-1c63-4b85-9f07-3e6c8a1d5b92",
                                        "attributes": {
                                            "title": "Dundies speech",
                                            "body": "## Best dressed\nPam, again.\n\n- [x] Book Chili's\n- [ ] Engrave the trophies",
                                            "headings": [
                                                {
                                                    "text": "Best dressed",
                                                    "level": 2,
                                                    "anchor": "section-best-dressed"
                                                }
                                            ],
                                            "folder": {
                                                "id": "2b7e4c91-0d5a-4f38-9c16-8e3a7f1b5d24",
                                                "name": "Office"
                                            },
                                            "created_at": 1773331200,
                                            "updated_at": 1773417600
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/knowledge/notes/7a2d9e4f-1c63-4b85-9f07-3e6c8a1d5b92",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/knowledge/notes/7a2d9e4f-1c63-4b85-9f07-3e6c8a1d5b92"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "knowledge-notes-show-query",
                "tags": [
                    "Knowledge notes"
                ],
                "summary": "Get a note",
                "description": "Retrieve one note with its text and its headings.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "note",
                        "in": "path",
                        "required": true,
                        "description": "The id of the note. A note of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A knowledge note object. A note of another vault or of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The knowledge note.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always knowledge_note. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "title": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The title of the note."
                                                        },
                                                        "folder": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The folder the note sits in.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the folder, as the knowledge folders endpoints give it."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What the folder is called."
                                                                }
                                                            }
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the note was written, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds, or null."
                                                        },
                                                        "body": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The text of the note in Markdown, exactly as written, or null. It is never drawn: raw HTML in it stays text, and the application escapes it when it shows the note."
                                                        },
                                                        "headings": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The headings of the text, from the first level to the third, in reading order.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One heading.",
                                                                "properties": {
                                                                    "text": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the heading says."
                                                                    },
                                                                    "level": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Its level, 1 to 3."
                                                                    },
                                                                    "anchor": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The anchor the application gives it, to open the note at that heading with links.web followed by # and the anchor."
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The note in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "knowledge_note",
                                        "id": "7a2d9e4f-1c63-4b85-9f07-3e6c8a1d5b92",
                                        "attributes": {
                                            "title": "Dundies speech",
                                            "body": "## Best dressed\nPam, again.\n\n- [x] Book Chili's\n- [ ] Engrave the trophies",
                                            "headings": [
                                                {
                                                    "text": "Best dressed",
                                                    "level": 2,
                                                    "anchor": "section-best-dressed"
                                                }
                                            ],
                                            "folder": {
                                                "id": "2b7e4c91-0d5a-4f38-9c16-8e3a7f1b5d24",
                                                "name": "Office"
                                            },
                                            "created_at": 1773331200,
                                            "updated_at": 1773417600
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/knowledge/notes/7a2d9e4f-1c63-4b85-9f07-3e6c8a1d5b92",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/knowledge/notes/7a2d9e4f-1c63-4b85-9f07-3e6c8a1d5b92"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "put": {
                "operationId": "knowledge-notes-update",
                "tags": [
                    "Knowledge notes"
                ],
                "summary": "Change a note",
                "description": "Change the title, the text or the folder of a note.\n\nA field left out keeps its value. A title left empty keeps the one the note had, and a text sent as null or empty clears it. The text replaces the whole text, so a task is ticked by sending the text back with [x] in place of [ ].\n\nThe change is written to the account log.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "note",
                        "in": "path",
                        "required": true,
                        "description": "The id of the note. A note of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "title": {
                                        "type": "string",
                                        "description": "The title of the note, up to 255 characters. Markup is stripped."
                                    },
                                    "body": {
                                        "type": "string",
                                        "description": "The text of the note in Markdown, up to 200,000 characters: # for a heading, - for a bullet, - [ ] for a task, > for a quote, **bold**. Web addresses become links on their own."
                                    },
                                    "folder_id": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "The folder to move the note to. The id of a folder of the vault, as the knowledge folders endpoints give it. A folder of another vault answers 404."
                                    }
                                }
                            },
                            "example": {
                                "body": "## Best dressed\nPam, again.\n\n- [x] Book Chili's\n- [ ] Engrave the trophies"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The knowledge note object as it now reads. A note of another vault or of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The knowledge note.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always knowledge_note. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "title": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The title of the note."
                                                        },
                                                        "folder": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The folder the note sits in.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the folder, as the knowledge folders endpoints give it."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What the folder is called."
                                                                }
                                                            }
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the note was written, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it last changed, as a count of seconds, or null."
                                                        },
                                                        "body": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The text of the note in Markdown, exactly as written, or null. It is never drawn: raw HTML in it stays text, and the application escapes it when it shows the note."
                                                        },
                                                        "headings": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The headings of the text, from the first level to the third, in reading order.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One heading.",
                                                                "properties": {
                                                                    "text": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the heading says."
                                                                    },
                                                                    "level": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Its level, 1 to 3."
                                                                    },
                                                                    "anchor": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The anchor the application gives it, to open the note at that heading with links.web followed by # and the anchor."
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The note in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "knowledge_note",
                                        "id": "7a2d9e4f-1c63-4b85-9f07-3e6c8a1d5b92",
                                        "attributes": {
                                            "title": "Dundies speech",
                                            "body": "## Best dressed\nPam, again.\n\n- [x] Book Chili's\n- [ ] Engrave the trophies",
                                            "headings": [
                                                {
                                                    "text": "Best dressed",
                                                    "level": 2,
                                                    "anchor": "section-best-dressed"
                                                }
                                            ],
                                            "folder": {
                                                "id": "2b7e4c91-0d5a-4f38-9c16-8e3a7f1b5d24",
                                                "name": "Office"
                                            },
                                            "created_at": 1773331200,
                                            "updated_at": 1773417600
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/knowledge/notes/7a2d9e4f-1c63-4b85-9f07-3e6c8a1d5b92",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/knowledge/notes/7a2d9e4f-1c63-4b85-9f07-3e6c8a1d5b92"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "delete": {
                "operationId": "knowledge-notes-destroy",
                "tags": [
                    "Knowledge notes"
                ],
                "summary": "Delete a note",
                "description": "Delete a note of a vault's Knowledge.\n\nThe deletion is final. The account log keeps the title of the note.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "note",
                        "in": "path",
                        "required": true,
                        "description": "The id of the note. A note of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Nothing. A note of another vault or of another account answers 404."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/knowledge/search": {
            "get": {
                "operationId": "knowledge-search",
                "tags": [
                    "Knowledge notes"
                ],
                "summary": "Search notes and lists",
                "description": "Find the notes and lists of a vault's Knowledge holding every word given.\n\nA note or a list is found when each word is in its title, its text, its description or any of its cells. Case and accents are ignored as the language of the account ignores them, a word is found at the start of a longer one, and one typing mistake is tolerated from five letters, two from nine.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "query",
                        "in": "query",
                        "required": true,
                        "description": "The words to find, at least two characters and up to 255.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The notes and the lists found, or an empty list. A vault of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "Every note found, then every list found, whole rather than a page at a time.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One knowledge note, or one knowledge list as the knowledge lists endpoints describe it, told apart by type.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "knowledge_note or knowledge_list."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of the note or the list."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the note holds, or what the list is without its columns and items.",
                                                        "properties": {
                                                            "title": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The title of the note."
                                                            },
                                                            "folder": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The folder the note sits in.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the folder, as the knowledge folders endpoints give it."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the folder is called."
                                                                    }
                                                                }
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the note was written, as a count of seconds since 1970."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds, or null."
                                                            },
                                                            "body": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The text of the note in Markdown, exactly as written, or null. It is never drawn: raw HTML in it stays text, and the application escapes it when it shows the note."
                                                            },
                                                            "headings": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "The headings of the text, from the first level to the third, in reading order.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One heading.",
                                                                    "properties": {
                                                                        "text": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "What the heading says."
                                                                        },
                                                                        "level": {
                                                                            "type": [
                                                                                "integer",
                                                                                "null"
                                                                            ],
                                                                            "description": "Its level, 1 to 3."
                                                                        },
                                                                        "anchor": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The anchor the application gives it, to open the note at that heading with links.web followed by # and the anchor."
                                                                        }
                                                                    }
                                                                }
                                                            },
                                                            "description": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "For a list, what it is for, in Markdown as written, or null. A note carries none."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this note or list.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address it is read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The note or the list in the application."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "knowledge_note",
                                            "id": "7a2d9e4f-1c63-4b85-9f07-3e6c8a1d5b92",
                                            "attributes": {
                                                "title": "Dundies speech",
                                                "body": "## Best dressed\nPam, again.\n\n- [x] Book Chili's\n- [ ] Engrave the trophies",
                                                "headings": [
                                                    {
                                                        "text": "Best dressed",
                                                        "level": 2,
                                                        "anchor": "section-best-dressed"
                                                    }
                                                ],
                                                "folder": {
                                                    "id": "2b7e4c91-0d5a-4f38-9c16-8e3a7f1b5d24",
                                                    "name": "Office"
                                                },
                                                "created_at": 1773331200,
                                                "updated_at": 1773417600
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/knowledge/notes/7a2d9e4f-1c63-4b85-9f07-3e6c8a1d5b92",
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/knowledge/notes/7a2d9e4f-1c63-4b85-9f07-3e6c8a1d5b92"
                                            }
                                        },
                                        {
                                            "type": "knowledge_list",
                                            "id": "6d1f8b34-2a95-4c7e-b0d3-9e5a1c7f4b26",
                                            "attributes": {
                                                "title": "Dundies nominees",
                                                "description": "Who might win this year.",
                                                "folder": {
                                                    "id": "2b7e4c91-0d5a-4f38-9c16-8e3a7f1b5d24",
                                                    "name": "Office"
                                                },
                                                "created_at": 1773331200,
                                                "updated_at": 1773417600
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/knowledge/lists/6d1f8b34-2a95-4c7e-b0d3-9e5a1c7f4b26",
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/knowledge/lists/6d1f8b34-2a95-4c7e-b0d3-9e5a1c7f4b26"
                                            }
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "knowledge-search-query",
                "tags": [
                    "Knowledge notes"
                ],
                "summary": "Search notes and lists",
                "description": "Find the notes and lists of a vault's Knowledge holding every word given.\n\nA note or a list is found when each word is in its title, its text, its description or any of its cells. Case and accents are ignored as the language of the account ignores them, a word is found at the start of a longer one, and one typing mistake is tolerated from five letters, two from nine.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "query": {
                                        "type": "string",
                                        "description": "The words to find, at least two characters and up to 255."
                                    }
                                },
                                "required": [
                                    "query"
                                ]
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The notes and the lists found, or an empty list. A vault of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "Every note found, then every list found, whole rather than a page at a time.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One knowledge note, or one knowledge list as the knowledge lists endpoints describe it, told apart by type.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "knowledge_note or knowledge_list."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of the note or the list."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the note holds, or what the list is without its columns and items.",
                                                        "properties": {
                                                            "title": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The title of the note."
                                                            },
                                                            "folder": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The folder the note sits in.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the folder, as the knowledge folders endpoints give it."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the folder is called."
                                                                    }
                                                                }
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the note was written, as a count of seconds since 1970."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it last changed, as a count of seconds, or null."
                                                            },
                                                            "body": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The text of the note in Markdown, exactly as written, or null. It is never drawn: raw HTML in it stays text, and the application escapes it when it shows the note."
                                                            },
                                                            "headings": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "The headings of the text, from the first level to the third, in reading order.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One heading.",
                                                                    "properties": {
                                                                        "text": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "What the heading says."
                                                                        },
                                                                        "level": {
                                                                            "type": [
                                                                                "integer",
                                                                                "null"
                                                                            ],
                                                                            "description": "Its level, 1 to 3."
                                                                        },
                                                                        "anchor": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The anchor the application gives it, to open the note at that heading with links.web followed by # and the anchor."
                                                                        }
                                                                    }
                                                                }
                                                            },
                                                            "description": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "For a list, what it is for, in Markdown as written, or null. A note carries none."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this note or list.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address it is read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The note or the list in the application."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "knowledge_note",
                                            "id": "7a2d9e4f-1c63-4b85-9f07-3e6c8a1d5b92",
                                            "attributes": {
                                                "title": "Dundies speech",
                                                "body": "## Best dressed\nPam, again.\n\n- [x] Book Chili's\n- [ ] Engrave the trophies",
                                                "headings": [
                                                    {
                                                        "text": "Best dressed",
                                                        "level": 2,
                                                        "anchor": "section-best-dressed"
                                                    }
                                                ],
                                                "folder": {
                                                    "id": "2b7e4c91-0d5a-4f38-9c16-8e3a7f1b5d24",
                                                    "name": "Office"
                                                },
                                                "created_at": 1773331200,
                                                "updated_at": 1773417600
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/knowledge/notes/7a2d9e4f-1c63-4b85-9f07-3e6c8a1d5b92",
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/knowledge/notes/7a2d9e4f-1c63-4b85-9f07-3e6c8a1d5b92"
                                            }
                                        },
                                        {
                                            "type": "knowledge_list",
                                            "id": "6d1f8b34-2a95-4c7e-b0d3-9e5a1c7f4b26",
                                            "attributes": {
                                                "title": "Dundies nominees",
                                                "description": "Who might win this year.",
                                                "folder": {
                                                    "id": "2b7e4c91-0d5a-4f38-9c16-8e3a7f1b5d24",
                                                    "name": "Office"
                                                },
                                                "created_at": 1773331200,
                                                "updated_at": 1773417600
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/knowledge/lists/6d1f8b34-2a95-4c7e-b0d3-9e5a1c7f4b26",
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/knowledge/lists/6d1f8b34-2a95-4c7e-b0d3-9e5a1c7f4b26"
                                            }
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/knowledge/lists": {
            "get": {
                "operationId": "knowledge-lists-index",
                "tags": [
                    "Knowledge lists"
                ],
                "summary": "List the lists of a vault",
                "description": "List the lists of a vault's Knowledge by title, without their columns and items.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "folder",
                        "in": "query",
                        "required": false,
                        "description": "Only the lists of this folder. The id of a folder of the vault, as the knowledge folders endpoints give it. A folder of another vault answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Every knowledge list object of the vault, without its columns and items, or an empty list. A vault of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "Every one of the lists, whole rather than a page at a time.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One knowledge list, without its columns and items.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always knowledge_list. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "title": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The title of the list."
                                                            },
                                                            "description": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the list is for, in Markdown as written, or null."
                                                            },
                                                            "folder": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The folder the list sits in.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the folder, as the knowledge folders endpoints give it."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the folder is called."
                                                                    }
                                                                }
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the list was started, as a count of seconds since 1970."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it, one of its columns or one of its items last changed, as a count of seconds, or null."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The list in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "knowledge_list",
                                            "id": "e94b1c37-6a28-4d50-8b3f-2c7e9a4d1f68",
                                            "attributes": {
                                                "title": "Paper clients",
                                                "description": "Who buys from the **Scranton** branch.",
                                                "folder": {
                                                    "id": "2b7e4c91-0d5a-4f38-9c16-8e3a7f1b5d24",
                                                    "name": "Office"
                                                },
                                                "created_at": 1773331200,
                                                "updated_at": 1773417600
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/knowledge/lists/e94b1c37-6a28-4d50-8b3f-2c7e9a4d1f68",
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/knowledge/lists/e94b1c37-6a28-4d50-8b3f-2c7e9a4d1f68"
                                            }
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "knowledge-lists-index-query",
                "tags": [
                    "Knowledge lists"
                ],
                "summary": "List the lists of a vault",
                "description": "List the lists of a vault's Knowledge by title, without their columns and items.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "folder": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "Only the lists of this folder. The id of a folder of the vault, as the knowledge folders endpoints give it. A folder of another vault answers 404."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Every knowledge list object of the vault, without its columns and items, or an empty list. A vault of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "Every one of the lists, whole rather than a page at a time.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One knowledge list, without its columns and items.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always knowledge_list. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "title": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The title of the list."
                                                            },
                                                            "description": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the list is for, in Markdown as written, or null."
                                                            },
                                                            "folder": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "The folder the list sits in.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the folder, as the knowledge folders endpoints give it."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the folder is called."
                                                                    }
                                                                }
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the list was started, as a count of seconds since 1970."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When it, one of its columns or one of its items last changed, as a count of seconds, or null."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The list in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "knowledge_list",
                                            "id": "e94b1c37-6a28-4d50-8b3f-2c7e9a4d1f68",
                                            "attributes": {
                                                "title": "Paper clients",
                                                "description": "Who buys from the **Scranton** branch.",
                                                "folder": {
                                                    "id": "2b7e4c91-0d5a-4f38-9c16-8e3a7f1b5d24",
                                                    "name": "Office"
                                                },
                                                "created_at": 1773331200,
                                                "updated_at": 1773417600
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/knowledge/lists/e94b1c37-6a28-4d50-8b3f-2c7e9a4d1f68",
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/knowledge/lists/e94b1c37-6a28-4d50-8b3f-2c7e9a4d1f68"
                                            }
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "post": {
                "operationId": "knowledge-lists-create",
                "tags": [
                    "Knowledge lists"
                ],
                "summary": "Start a list",
                "description": "Start a list in a vault's Knowledge, with the columns Name and Note.\n\nEvery field is optional. A list without a title is called “Untitled list”. Without a folder it goes to the first folder of the vault, and a vault without any folder gets one called “General” to hold it. Rename, add or remove columns through the columns endpoints.\n\nThe change is written to the account log.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "title": {
                                        "type": "string",
                                        "description": "The title of the list, up to 255 characters. Markup is stripped."
                                    },
                                    "description": {
                                        "type": "string",
                                        "description": "What the list is for, in Markdown, up to 5,000 characters."
                                    },
                                    "folder_id": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "The id of a folder of the vault, as the knowledge folders endpoints give it. A folder of another vault answers 404."
                                    }
                                }
                            },
                            "example": {
                                "title": "Paper clients",
                                "description": "Who buys from the **Scranton** branch.",
                                "folder_id": "2b7e4c91-0d5a-4f38-9c16-8e3a7f1b5d24"
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The knowledge list object that was started.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The knowledge list, which holds no item yet.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always knowledge_list. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "title": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The title of the list."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the list is for, in Markdown as written, or null."
                                                        },
                                                        "folder": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The folder the list sits in.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the folder, as the knowledge folders endpoints give it."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What the folder is called."
                                                                }
                                                            }
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the list was started, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it, one of its columns or one of its items last changed, as a count of seconds, or null."
                                                        },
                                                        "columns": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The columns of the list, in their order. A list always has at least one.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One column.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the column, which the columns endpoints and the cells of an item take."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the column is called."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Where the column stands, from 1."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "items": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The items of the list, in their order."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The list in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "knowledge_list",
                                        "id": "e94b1c37-6a28-4d50-8b3f-2c7e9a4d1f68",
                                        "attributes": {
                                            "title": "Paper clients",
                                            "description": "Who buys from the **Scranton** branch.",
                                            "folder": {
                                                "id": "2b7e4c91-0d5a-4f38-9c16-8e3a7f1b5d24",
                                                "name": "Office"
                                            },
                                            "columns": [
                                                {
                                                    "id": "5d3a8f12-7c49-4e60-b2a1-9f6e3c8d4b75",
                                                    "name": "Name",
                                                    "position": 1
                                                },
                                                {
                                                    "id": "0f7b2d95-3e61-4a8c-9d47-6b1e8c5a3f29",
                                                    "name": "Note",
                                                    "position": 2
                                                }
                                            ],
                                            "items": [],
                                            "created_at": 1773331200,
                                            "updated_at": 1773417600
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/knowledge/lists/e94b1c37-6a28-4d50-8b3f-2c7e9a4d1f68",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/knowledge/lists/e94b1c37-6a28-4d50-8b3f-2c7e9a4d1f68"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/knowledge/lists/{list}": {
            "get": {
                "operationId": "knowledge-lists-show",
                "tags": [
                    "Knowledge lists"
                ],
                "summary": "Get a list",
                "description": "Retrieve one list with its columns and its items.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "list",
                        "in": "path",
                        "required": true,
                        "description": "The id of the list. A list of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A knowledge list object. A list of another vault or of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The knowledge list.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always knowledge_list. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "title": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The title of the list."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the list is for, in Markdown as written, or null."
                                                        },
                                                        "folder": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The folder the list sits in.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the folder, as the knowledge folders endpoints give it."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What the folder is called."
                                                                }
                                                            }
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the list was started, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it, one of its columns or one of its items last changed, as a count of seconds, or null."
                                                        },
                                                        "columns": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The columns of the list, in their order. A list always has at least one.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One column.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the column, which the columns endpoints and the cells of an item take."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the column is called."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Where the column stands, from 1."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "items": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The items of the list, in their order.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One item.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the item, which the items endpoints take."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Where the item stands, from 1."
                                                                    },
                                                                    "cells": {
                                                                        "type": [
                                                                            "object",
                                                                            "null"
                                                                        ],
                                                                        "additionalProperties": true,
                                                                        "description": "The texts of the item in Markdown, keyed by the id of their column. A blank cell is left out."
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The list in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "knowledge_list",
                                        "id": "e94b1c37-6a28-4d50-8b3f-2c7e9a4d1f68",
                                        "attributes": {
                                            "title": "Paper clients",
                                            "description": "Who buys from the **Scranton** branch.",
                                            "folder": {
                                                "id": "2b7e4c91-0d5a-4f38-9c16-8e3a7f1b5d24",
                                                "name": "Office"
                                            },
                                            "columns": [
                                                {
                                                    "id": "5d3a8f12-7c49-4e60-b2a1-9f6e3c8d4b75",
                                                    "name": "Name",
                                                    "position": 1
                                                },
                                                {
                                                    "id": "a18c6e43-2f97-4b5d-8e01-7c3b9a6f2d84",
                                                    "name": "City",
                                                    "position": 2
                                                },
                                                {
                                                    "id": "0f7b2d95-3e61-4a8c-9d47-6b1e8c5a3f29",
                                                    "name": "Note",
                                                    "position": 3
                                                }
                                            ],
                                            "items": [
                                                {
                                                    "id": "8e4f1a76-5c23-4d9b-a0e8-2b7d6f3c1e54",
                                                    "position": 1,
                                                    "cells": {
                                                        "5d3a8f12-7c49-4e60-b2a1-9f6e3c8d4b75": "Blue Cross of Pennsylvania",
                                                        "a18c6e43-2f97-4b5d-8e01-7c3b9a6f2d84": "Scranton"
                                                    }
                                                },
                                                {
                                                    "id": "3c9d7b28-1f54-4e8a-b6c0-5a2e9d4f7b13",
                                                    "position": 2,
                                                    "cells": {
                                                        "5d3a8f12-7c49-4e60-b2a1-9f6e3c8d4b75": "Harper Collins",
                                                        "0f7b2d95-3e61-4a8c-9d47-6b1e8c5a3f29": "Lost to Prince Family Paper, won back"
                                                    }
                                                }
                                            ],
                                            "created_at": 1773331200,
                                            "updated_at": 1773417600
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/knowledge/lists/e94b1c37-6a28-4d50-8b3f-2c7e9a4d1f68",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/knowledge/lists/e94b1c37-6a28-4d50-8b3f-2c7e9a4d1f68"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "knowledge-lists-show-query",
                "tags": [
                    "Knowledge lists"
                ],
                "summary": "Get a list",
                "description": "Retrieve one list with its columns and its items.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "list",
                        "in": "path",
                        "required": true,
                        "description": "The id of the list. A list of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A knowledge list object. A list of another vault or of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The knowledge list.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always knowledge_list. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "title": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The title of the list."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the list is for, in Markdown as written, or null."
                                                        },
                                                        "folder": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The folder the list sits in.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the folder, as the knowledge folders endpoints give it."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What the folder is called."
                                                                }
                                                            }
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the list was started, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it, one of its columns or one of its items last changed, as a count of seconds, or null."
                                                        },
                                                        "columns": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The columns of the list, in their order. A list always has at least one.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One column.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the column, which the columns endpoints and the cells of an item take."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the column is called."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Where the column stands, from 1."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "items": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The items of the list, in their order.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One item.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the item, which the items endpoints take."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Where the item stands, from 1."
                                                                    },
                                                                    "cells": {
                                                                        "type": [
                                                                            "object",
                                                                            "null"
                                                                        ],
                                                                        "additionalProperties": true,
                                                                        "description": "The texts of the item in Markdown, keyed by the id of their column. A blank cell is left out."
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The list in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "knowledge_list",
                                        "id": "e94b1c37-6a28-4d50-8b3f-2c7e9a4d1f68",
                                        "attributes": {
                                            "title": "Paper clients",
                                            "description": "Who buys from the **Scranton** branch.",
                                            "folder": {
                                                "id": "2b7e4c91-0d5a-4f38-9c16-8e3a7f1b5d24",
                                                "name": "Office"
                                            },
                                            "columns": [
                                                {
                                                    "id": "5d3a8f12-7c49-4e60-b2a1-9f6e3c8d4b75",
                                                    "name": "Name",
                                                    "position": 1
                                                },
                                                {
                                                    "id": "a18c6e43-2f97-4b5d-8e01-7c3b9a6f2d84",
                                                    "name": "City",
                                                    "position": 2
                                                },
                                                {
                                                    "id": "0f7b2d95-3e61-4a8c-9d47-6b1e8c5a3f29",
                                                    "name": "Note",
                                                    "position": 3
                                                }
                                            ],
                                            "items": [
                                                {
                                                    "id": "8e4f1a76-5c23-4d9b-a0e8-2b7d6f3c1e54",
                                                    "position": 1,
                                                    "cells": {
                                                        "5d3a8f12-7c49-4e60-b2a1-9f6e3c8d4b75": "Blue Cross of Pennsylvania",
                                                        "a18c6e43-2f97-4b5d-8e01-7c3b9a6f2d84": "Scranton"
                                                    }
                                                },
                                                {
                                                    "id": "3c9d7b28-1f54-4e8a-b6c0-5a2e9d4f7b13",
                                                    "position": 2,
                                                    "cells": {
                                                        "5d3a8f12-7c49-4e60-b2a1-9f6e3c8d4b75": "Harper Collins",
                                                        "0f7b2d95-3e61-4a8c-9d47-6b1e8c5a3f29": "Lost to Prince Family Paper, won back"
                                                    }
                                                }
                                            ],
                                            "created_at": 1773331200,
                                            "updated_at": 1773417600
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/knowledge/lists/e94b1c37-6a28-4d50-8b3f-2c7e9a4d1f68",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/knowledge/lists/e94b1c37-6a28-4d50-8b3f-2c7e9a4d1f68"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "put": {
                "operationId": "knowledge-lists-update",
                "tags": [
                    "Knowledge lists"
                ],
                "summary": "Change a list",
                "description": "Change the title, the description or the folder of a list.\n\nA field left out keeps its value. A title left empty keeps the one the list had, and a description sent as null or empty clears it.\n\nThe change is written to the account log.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "list",
                        "in": "path",
                        "required": true,
                        "description": "The id of the list. A list of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "title": {
                                        "type": "string",
                                        "description": "The new title, up to 255 characters."
                                    },
                                    "description": {
                                        "type": "string",
                                        "description": "What the list is for, in Markdown, up to 5,000 characters."
                                    },
                                    "folder_id": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "The folder to move the list to. The id of a folder of the vault, as the knowledge folders endpoints give it. A folder of another vault answers 404."
                                    }
                                }
                            },
                            "example": {
                                "description": "Who buys from the **Scranton** branch."
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The knowledge list object as it now reads. A list of another vault or of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The knowledge list.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always knowledge_list. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "title": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The title of the list."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the list is for, in Markdown as written, or null."
                                                        },
                                                        "folder": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The folder the list sits in.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the folder, as the knowledge folders endpoints give it."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What the folder is called."
                                                                }
                                                            }
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the list was started, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it, one of its columns or one of its items last changed, as a count of seconds, or null."
                                                        },
                                                        "columns": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The columns of the list, in their order. A list always has at least one.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One column.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the column, which the columns endpoints and the cells of an item take."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the column is called."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Where the column stands, from 1."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "items": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The items of the list, in their order.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One item.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the item, which the items endpoints take."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Where the item stands, from 1."
                                                                    },
                                                                    "cells": {
                                                                        "type": [
                                                                            "object",
                                                                            "null"
                                                                        ],
                                                                        "additionalProperties": true,
                                                                        "description": "The texts of the item in Markdown, keyed by the id of their column. A blank cell is left out."
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The list in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "knowledge_list",
                                        "id": "e94b1c37-6a28-4d50-8b3f-2c7e9a4d1f68",
                                        "attributes": {
                                            "title": "Paper clients",
                                            "description": "Who buys from the **Scranton** branch.",
                                            "folder": {
                                                "id": "2b7e4c91-0d5a-4f38-9c16-8e3a7f1b5d24",
                                                "name": "Office"
                                            },
                                            "columns": [
                                                {
                                                    "id": "5d3a8f12-7c49-4e60-b2a1-9f6e3c8d4b75",
                                                    "name": "Name",
                                                    "position": 1
                                                },
                                                {
                                                    "id": "a18c6e43-2f97-4b5d-8e01-7c3b9a6f2d84",
                                                    "name": "City",
                                                    "position": 2
                                                },
                                                {
                                                    "id": "0f7b2d95-3e61-4a8c-9d47-6b1e8c5a3f29",
                                                    "name": "Note",
                                                    "position": 3
                                                }
                                            ],
                                            "items": [
                                                {
                                                    "id": "8e4f1a76-5c23-4d9b-a0e8-2b7d6f3c1e54",
                                                    "position": 1,
                                                    "cells": {
                                                        "5d3a8f12-7c49-4e60-b2a1-9f6e3c8d4b75": "Blue Cross of Pennsylvania",
                                                        "a18c6e43-2f97-4b5d-8e01-7c3b9a6f2d84": "Scranton"
                                                    }
                                                },
                                                {
                                                    "id": "3c9d7b28-1f54-4e8a-b6c0-5a2e9d4f7b13",
                                                    "position": 2,
                                                    "cells": {
                                                        "5d3a8f12-7c49-4e60-b2a1-9f6e3c8d4b75": "Harper Collins",
                                                        "0f7b2d95-3e61-4a8c-9d47-6b1e8c5a3f29": "Lost to Prince Family Paper, won back"
                                                    }
                                                }
                                            ],
                                            "created_at": 1773331200,
                                            "updated_at": 1773417600
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/knowledge/lists/e94b1c37-6a28-4d50-8b3f-2c7e9a4d1f68",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/knowledge/lists/e94b1c37-6a28-4d50-8b3f-2c7e9a4d1f68"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "delete": {
                "operationId": "knowledge-lists-destroy",
                "tags": [
                    "Knowledge lists"
                ],
                "summary": "Delete a list",
                "description": "Delete a list with its columns and every item in it.\n\nThe deletion is final. The account log keeps the title of the list.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "list",
                        "in": "path",
                        "required": true,
                        "description": "The id of the list. A list of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Nothing. A list of another vault or of another account answers 404."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/knowledge/lists/{list}/columns": {
            "post": {
                "operationId": "knowledge-list-columns-create",
                "tags": [
                    "Knowledge lists"
                ],
                "summary": "Add a column",
                "description": "Add a column to a list, after its other columns. Every item reads it as blank until something is written in it.\n\nThe change is written to the account log.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "list",
                        "in": "path",
                        "required": true,
                        "description": "The id of the list. A list of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "description": "What the column is called, up to 255 characters. A name left empty once markup is stripped is refused with “Give the column a name.”"
                                    }
                                },
                                "required": [
                                    "name"
                                ]
                            },
                            "example": {
                                "name": "City"
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The whole knowledge list object, with its new column.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The knowledge list.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always knowledge_list. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "title": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The title of the list."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the list is for, in Markdown as written, or null."
                                                        },
                                                        "folder": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The folder the list sits in.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the folder, as the knowledge folders endpoints give it."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What the folder is called."
                                                                }
                                                            }
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the list was started, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it, one of its columns or one of its items last changed, as a count of seconds, or null."
                                                        },
                                                        "columns": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The columns of the list, in their order. A list always has at least one.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One column.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the column, which the columns endpoints and the cells of an item take."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the column is called."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Where the column stands, from 1."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "items": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The items of the list, in their order.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One item.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the item, which the items endpoints take."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Where the item stands, from 1."
                                                                    },
                                                                    "cells": {
                                                                        "type": [
                                                                            "object",
                                                                            "null"
                                                                        ],
                                                                        "additionalProperties": true,
                                                                        "description": "The texts of the item in Markdown, keyed by the id of their column. A blank cell is left out."
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The list in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "knowledge_list",
                                        "id": "e94b1c37-6a28-4d50-8b3f-2c7e9a4d1f68",
                                        "attributes": {
                                            "title": "Paper clients",
                                            "description": "Who buys from the **Scranton** branch.",
                                            "folder": {
                                                "id": "2b7e4c91-0d5a-4f38-9c16-8e3a7f1b5d24",
                                                "name": "Office"
                                            },
                                            "columns": [
                                                {
                                                    "id": "5d3a8f12-7c49-4e60-b2a1-9f6e3c8d4b75",
                                                    "name": "Name",
                                                    "position": 1
                                                },
                                                {
                                                    "id": "a18c6e43-2f97-4b5d-8e01-7c3b9a6f2d84",
                                                    "name": "City",
                                                    "position": 2
                                                },
                                                {
                                                    "id": "0f7b2d95-3e61-4a8c-9d47-6b1e8c5a3f29",
                                                    "name": "Note",
                                                    "position": 3
                                                }
                                            ],
                                            "items": [
                                                {
                                                    "id": "8e4f1a76-5c23-4d9b-a0e8-2b7d6f3c1e54",
                                                    "position": 1,
                                                    "cells": {
                                                        "5d3a8f12-7c49-4e60-b2a1-9f6e3c8d4b75": "Blue Cross of Pennsylvania",
                                                        "a18c6e43-2f97-4b5d-8e01-7c3b9a6f2d84": "Scranton"
                                                    }
                                                },
                                                {
                                                    "id": "3c9d7b28-1f54-4e8a-b6c0-5a2e9d4f7b13",
                                                    "position": 2,
                                                    "cells": {
                                                        "5d3a8f12-7c49-4e60-b2a1-9f6e3c8d4b75": "Harper Collins",
                                                        "0f7b2d95-3e61-4a8c-9d47-6b1e8c5a3f29": "Lost to Prince Family Paper, won back"
                                                    }
                                                }
                                            ],
                                            "created_at": 1773331200,
                                            "updated_at": 1773417600
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/knowledge/lists/e94b1c37-6a28-4d50-8b3f-2c7e9a4d1f68",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/knowledge/lists/e94b1c37-6a28-4d50-8b3f-2c7e9a4d1f68"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/knowledge/lists/{list}/columns/{column}": {
            "put": {
                "operationId": "knowledge-list-columns-update",
                "tags": [
                    "Knowledge lists"
                ],
                "summary": "Rename or move a column",
                "description": "Rename a column, move it among the columns of its list, or both.\n\nA field left out keeps its value. The other columns shift so the positions run from 1 without a gap.\n\nThe change is written to the account log.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "list",
                        "in": "path",
                        "required": true,
                        "description": "The id of the list. A list of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "column",
                        "in": "path",
                        "required": true,
                        "description": "The id of the column. A column of another list answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "description": "The new name, up to 255 characters. A name left empty keeps the one the column had."
                                    },
                                    "position": {
                                        "type": "integer",
                                        "description": "Where the column goes, 1 for first. A number past the end puts it last."
                                    }
                                }
                            },
                            "example": {
                                "name": "City",
                                "position": 2
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The whole knowledge list object as it now reads.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The knowledge list.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always knowledge_list. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "title": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The title of the list."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the list is for, in Markdown as written, or null."
                                                        },
                                                        "folder": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The folder the list sits in.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the folder, as the knowledge folders endpoints give it."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What the folder is called."
                                                                }
                                                            }
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the list was started, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it, one of its columns or one of its items last changed, as a count of seconds, or null."
                                                        },
                                                        "columns": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The columns of the list, in their order. A list always has at least one.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One column.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the column, which the columns endpoints and the cells of an item take."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the column is called."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Where the column stands, from 1."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "items": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The items of the list, in their order.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One item.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the item, which the items endpoints take."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Where the item stands, from 1."
                                                                    },
                                                                    "cells": {
                                                                        "type": [
                                                                            "object",
                                                                            "null"
                                                                        ],
                                                                        "additionalProperties": true,
                                                                        "description": "The texts of the item in Markdown, keyed by the id of their column. A blank cell is left out."
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The list in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "knowledge_list",
                                        "id": "e94b1c37-6a28-4d50-8b3f-2c7e9a4d1f68",
                                        "attributes": {
                                            "title": "Paper clients",
                                            "description": "Who buys from the **Scranton** branch.",
                                            "folder": {
                                                "id": "2b7e4c91-0d5a-4f38-9c16-8e3a7f1b5d24",
                                                "name": "Office"
                                            },
                                            "columns": [
                                                {
                                                    "id": "5d3a8f12-7c49-4e60-b2a1-9f6e3c8d4b75",
                                                    "name": "Name",
                                                    "position": 1
                                                },
                                                {
                                                    "id": "a18c6e43-2f97-4b5d-8e01-7c3b9a6f2d84",
                                                    "name": "City",
                                                    "position": 2
                                                },
                                                {
                                                    "id": "0f7b2d95-3e61-4a8c-9d47-6b1e8c5a3f29",
                                                    "name": "Note",
                                                    "position": 3
                                                }
                                            ],
                                            "items": [
                                                {
                                                    "id": "8e4f1a76-5c23-4d9b-a0e8-2b7d6f3c1e54",
                                                    "position": 1,
                                                    "cells": {
                                                        "5d3a8f12-7c49-4e60-b2a1-9f6e3c8d4b75": "Blue Cross of Pennsylvania",
                                                        "a18c6e43-2f97-4b5d-8e01-7c3b9a6f2d84": "Scranton"
                                                    }
                                                },
                                                {
                                                    "id": "3c9d7b28-1f54-4e8a-b6c0-5a2e9d4f7b13",
                                                    "position": 2,
                                                    "cells": {
                                                        "5d3a8f12-7c49-4e60-b2a1-9f6e3c8d4b75": "Harper Collins",
                                                        "0f7b2d95-3e61-4a8c-9d47-6b1e8c5a3f29": "Lost to Prince Family Paper, won back"
                                                    }
                                                }
                                            ],
                                            "created_at": 1773331200,
                                            "updated_at": 1773417600
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/knowledge/lists/e94b1c37-6a28-4d50-8b3f-2c7e9a4d1f68",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/knowledge/lists/e94b1c37-6a28-4d50-8b3f-2c7e9a4d1f68"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "delete": {
                "operationId": "knowledge-list-columns-destroy",
                "tags": [
                    "Knowledge lists"
                ],
                "summary": "Remove a column",
                "description": "Remove a column from a list, with what every item holds in it.\n\nThe deletion is final. The last column of a list cannot be removed, and is refused with 422 and “The last column cannot be removed. A list needs at least one.”\n\nThe change is written to the account log.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "list",
                        "in": "path",
                        "required": true,
                        "description": "The id of the list. A list of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "column",
                        "in": "path",
                        "required": true,
                        "description": "The id of the column. A column of another list answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Nothing. A column of another list answers 404."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/knowledge/lists/{list}/items": {
            "post": {
                "operationId": "knowledge-list-items-create",
                "tags": [
                    "Knowledge lists"
                ],
                "summary": "Add an item",
                "description": "Add an item to a list, after its other items.\n\nAn item whose texts are all blank is refused with “Write something in at least one column.”\n\nThe change is written to the account log.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "list",
                        "in": "path",
                        "required": true,
                        "description": "The id of the list. A list of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "cells": {
                                        "type": "object",
                                        "description": "The texts of the item, keyed by the id of their column, each in Markdown and up to 5,000 characters. A key naming no column of the list answers 422."
                                    }
                                },
                                "required": [
                                    "cells"
                                ]
                            },
                            "example": {
                                "cells": {
                                    "5d3a8f12-7c49-4e60-b2a1-9f6e3c8d4b75": "Harper Collins",
                                    "0f7b2d95-3e61-4a8c-9d47-6b1e8c5a3f29": "Lost to Prince Family Paper, won back"
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The whole knowledge list object, with its new item.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The knowledge list.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always knowledge_list. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "title": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The title of the list."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the list is for, in Markdown as written, or null."
                                                        },
                                                        "folder": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The folder the list sits in.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the folder, as the knowledge folders endpoints give it."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What the folder is called."
                                                                }
                                                            }
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the list was started, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it, one of its columns or one of its items last changed, as a count of seconds, or null."
                                                        },
                                                        "columns": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The columns of the list, in their order. A list always has at least one.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One column.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the column, which the columns endpoints and the cells of an item take."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the column is called."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Where the column stands, from 1."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "items": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The items of the list, in their order.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One item.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the item, which the items endpoints take."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Where the item stands, from 1."
                                                                    },
                                                                    "cells": {
                                                                        "type": [
                                                                            "object",
                                                                            "null"
                                                                        ],
                                                                        "additionalProperties": true,
                                                                        "description": "The texts of the item in Markdown, keyed by the id of their column. A blank cell is left out."
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The list in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "knowledge_list",
                                        "id": "e94b1c37-6a28-4d50-8b3f-2c7e9a4d1f68",
                                        "attributes": {
                                            "title": "Paper clients",
                                            "description": "Who buys from the **Scranton** branch.",
                                            "folder": {
                                                "id": "2b7e4c91-0d5a-4f38-9c16-8e3a7f1b5d24",
                                                "name": "Office"
                                            },
                                            "columns": [
                                                {
                                                    "id": "5d3a8f12-7c49-4e60-b2a1-9f6e3c8d4b75",
                                                    "name": "Name",
                                                    "position": 1
                                                },
                                                {
                                                    "id": "a18c6e43-2f97-4b5d-8e01-7c3b9a6f2d84",
                                                    "name": "City",
                                                    "position": 2
                                                },
                                                {
                                                    "id": "0f7b2d95-3e61-4a8c-9d47-6b1e8c5a3f29",
                                                    "name": "Note",
                                                    "position": 3
                                                }
                                            ],
                                            "items": [
                                                {
                                                    "id": "8e4f1a76-5c23-4d9b-a0e8-2b7d6f3c1e54",
                                                    "position": 1,
                                                    "cells": {
                                                        "5d3a8f12-7c49-4e60-b2a1-9f6e3c8d4b75": "Blue Cross of Pennsylvania",
                                                        "a18c6e43-2f97-4b5d-8e01-7c3b9a6f2d84": "Scranton"
                                                    }
                                                },
                                                {
                                                    "id": "3c9d7b28-1f54-4e8a-b6c0-5a2e9d4f7b13",
                                                    "position": 2,
                                                    "cells": {
                                                        "5d3a8f12-7c49-4e60-b2a1-9f6e3c8d4b75": "Harper Collins",
                                                        "0f7b2d95-3e61-4a8c-9d47-6b1e8c5a3f29": "Lost to Prince Family Paper, won back"
                                                    }
                                                }
                                            ],
                                            "created_at": 1773331200,
                                            "updated_at": 1773417600
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/knowledge/lists/e94b1c37-6a28-4d50-8b3f-2c7e9a4d1f68",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/knowledge/lists/e94b1c37-6a28-4d50-8b3f-2c7e9a4d1f68"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/knowledge/lists/{list}/items/{item}": {
            "put": {
                "operationId": "knowledge-list-items-update",
                "tags": [
                    "Knowledge lists"
                ],
                "summary": "Change an item",
                "description": "Change the texts of an item.\n\nOnly the columns sent change, and a text sent empty empties its cell. An item left with every text blank is refused with “Write something in at least one column.”\n\nThe change is written to the account log.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "list",
                        "in": "path",
                        "required": true,
                        "description": "The id of the list. A list of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "item",
                        "in": "path",
                        "required": true,
                        "description": "The id of the item. An item of another list answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "cells": {
                                        "type": "object",
                                        "description": "The texts of the item, keyed by the id of their column, each in Markdown and up to 5,000 characters. A key naming no column of the list answers 422."
                                    }
                                },
                                "required": [
                                    "cells"
                                ]
                            },
                            "example": {
                                "cells": {
                                    "a18c6e43-2f97-4b5d-8e01-7c3b9a6f2d84": "Scranton"
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The whole knowledge list object as it now reads.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The knowledge list.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always knowledge_list. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "title": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The title of the list."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the list is for, in Markdown as written, or null."
                                                        },
                                                        "folder": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "The folder the list sits in.",
                                                            "properties": {
                                                                "id": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "format": "uuid",
                                                                    "description": "The id of the folder, as the knowledge folders endpoints give it."
                                                                },
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "What the folder is called."
                                                                }
                                                            }
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the list was started, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When it, one of its columns or one of its items last changed, as a count of seconds, or null."
                                                        },
                                                        "columns": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The columns of the list, in their order. A list always has at least one.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One column.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the column, which the columns endpoints and the cells of an item take."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What the column is called."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Where the column stands, from 1."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "items": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The items of the list, in their order.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One item.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the item, which the items endpoints take."
                                                                    },
                                                                    "position": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "Where the item stands, from 1."
                                                                    },
                                                                    "cells": {
                                                                        "type": [
                                                                            "object",
                                                                            "null"
                                                                        ],
                                                                        "additionalProperties": true,
                                                                        "description": "The texts of the item in Markdown, keyed by the id of their column. A blank cell is left out."
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The list in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "knowledge_list",
                                        "id": "e94b1c37-6a28-4d50-8b3f-2c7e9a4d1f68",
                                        "attributes": {
                                            "title": "Paper clients",
                                            "description": "Who buys from the **Scranton** branch.",
                                            "folder": {
                                                "id": "2b7e4c91-0d5a-4f38-9c16-8e3a7f1b5d24",
                                                "name": "Office"
                                            },
                                            "columns": [
                                                {
                                                    "id": "5d3a8f12-7c49-4e60-b2a1-9f6e3c8d4b75",
                                                    "name": "Name",
                                                    "position": 1
                                                },
                                                {
                                                    "id": "a18c6e43-2f97-4b5d-8e01-7c3b9a6f2d84",
                                                    "name": "City",
                                                    "position": 2
                                                },
                                                {
                                                    "id": "0f7b2d95-3e61-4a8c-9d47-6b1e8c5a3f29",
                                                    "name": "Note",
                                                    "position": 3
                                                }
                                            ],
                                            "items": [
                                                {
                                                    "id": "8e4f1a76-5c23-4d9b-a0e8-2b7d6f3c1e54",
                                                    "position": 1,
                                                    "cells": {
                                                        "5d3a8f12-7c49-4e60-b2a1-9f6e3c8d4b75": "Blue Cross of Pennsylvania",
                                                        "a18c6e43-2f97-4b5d-8e01-7c3b9a6f2d84": "Scranton"
                                                    }
                                                },
                                                {
                                                    "id": "3c9d7b28-1f54-4e8a-b6c0-5a2e9d4f7b13",
                                                    "position": 2,
                                                    "cells": {
                                                        "5d3a8f12-7c49-4e60-b2a1-9f6e3c8d4b75": "Harper Collins",
                                                        "0f7b2d95-3e61-4a8c-9d47-6b1e8c5a3f29": "Lost to Prince Family Paper, won back"
                                                    }
                                                }
                                            ],
                                            "created_at": 1773331200,
                                            "updated_at": 1773417600
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/knowledge/lists/e94b1c37-6a28-4d50-8b3f-2c7e9a4d1f68",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/knowledge/lists/e94b1c37-6a28-4d50-8b3f-2c7e9a4d1f68"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "delete": {
                "operationId": "knowledge-list-items-destroy",
                "tags": [
                    "Knowledge lists"
                ],
                "summary": "Delete an item",
                "description": "Delete an item of a list, with everything written in it.\n\nThe deletion is final.\n\nThe change is written to the account log.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "list",
                        "in": "path",
                        "required": true,
                        "description": "The id of the list. A list of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "item",
                        "in": "path",
                        "required": true,
                        "description": "The id of the item. An item of another list answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Nothing. An item of another list answers 404."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/possessions/{possession}/valuations": {
            "get": {
                "operationId": "possession-valuations-index",
                "tags": [
                    "Possession valuations"
                ],
                "summary": "List the valuations of a possession",
                "description": "List every valuation of a possession, the latest by date first.\n\nOn the same day, the latest recorded comes first. The first one is the current value. The list is whole rather than paginated.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Every valuation object of the possession, or an empty list. A vault or a possession of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "Every one of the possession valuations, whole rather than a page at a time.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One possession valuation.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always possession_valuation. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "type": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Where the figure comes from: own_estimate, appraisal, insurance_declaration, auction_result, comparable_listing or offer_received."
                                                            },
                                                            "valued_on": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The day the estimate applies to, written as 2026-03-14."
                                                            },
                                                            "confidence": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "How sure somebody is of the figure: unknown, certain, probable or uncertain."
                                                            },
                                                            "amount": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the possession is worth, as a string with two decimals."
                                                            },
                                                            "currency": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The currency of the amount, in lower case. Nothing is ever converted."
                                                            },
                                                            "is_current": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether this valuation gives the current value of the possession: the latest by date, the latest recorded on a tie."
                                                            },
                                                            "valuer": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Who estimated it, as text, or null."
                                                            },
                                                            "method": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "How it was estimated, or null."
                                                            },
                                                            "reference_number": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The reference of the appraisal, the listing or the offer, or null."
                                                            },
                                                            "source_url": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Where the valuation can be checked, or null."
                                                            },
                                                            "note": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Anything worth remembering about the valuation, or null."
                                                            },
                                                            "documents": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "The certificates, listings and offers attached to it, oldest first.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One document.",
                                                                    "properties": {
                                                                        "id": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "format": "uuid",
                                                                            "description": "The id of the file, which is what removing the document takes."
                                                                        },
                                                                        "name": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The name of the file as it was uploaded."
                                                                        },
                                                                        "mime_type": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The kind of the file, such as application/pdf."
                                                                        },
                                                                        "size_in_bytes": {
                                                                            "type": [
                                                                                "integer",
                                                                                "null"
                                                                            ],
                                                                            "description": "How much storage the file takes."
                                                                        }
                                                                    }
                                                                }
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the valuation was recorded, as a count of seconds since 1970. A valuation is never changed, so it has no time of change."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The Valuations section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "possession_valuation",
                                            "id": "3d7b1e94-8a2c-4f60-b5d3-6e19c0a7f248",
                                            "attributes": {
                                                "type": "appraisal",
                                                "valued_on": "2026-03-14",
                                                "confidence": "certain",
                                                "amount": "650.00",
                                                "currency": "usd",
                                                "is_current": true,
                                                "valuer": "Scranton Jewelers",
                                                "method": "Inspection and comparable sales",
                                                "reference_number": "APP-2026-0212",
                                                "source_url": "https://scrantonjewelers.example.com/appraisals/0212",
                                                "note": "Michael insists the gold paint adds to its worth.",
                                                "documents": [
                                                    {
                                                        "id": "6f2a9d48-1c7e-4b35-a8f0-2e5d9b4c7a16",
                                                        "name": "Appraisal certificate.pdf",
                                                        "mime_type": "application/pdf",
                                                        "size_in_bytes": 240000
                                                    }
                                                ],
                                                "created_at": 1773446400
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/valuations/3d7b1e94-8a2c-4f60-b5d3-6e19c0a7f248",
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/valuations"
                                            }
                                        },
                                        {
                                            "type": "possession_valuation",
                                            "id": "b81f5c3a-2d49-4e7b-9a06-f4c8e2d17b53",
                                            "attributes": {
                                                "type": "own_estimate",
                                                "valued_on": "2019-11-20",
                                                "confidence": "uncertain",
                                                "amount": "500.00",
                                                "currency": "usd",
                                                "is_current": false,
                                                "valuer": "Michael Scott",
                                                "method": null,
                                                "reference_number": null,
                                                "source_url": null,
                                                "note": null,
                                                "documents": [],
                                                "created_at": 1761436800
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/valuations/b81f5c3a-2d49-4e7b-9a06-f4c8e2d17b53",
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/valuations"
                                            }
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "possession-valuations-index-query",
                "tags": [
                    "Possession valuations"
                ],
                "summary": "List the valuations of a possession",
                "description": "List every valuation of a possession, the latest by date first.\n\nOn the same day, the latest recorded comes first. The first one is the current value. The list is whole rather than paginated.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Every valuation object of the possession, or an empty list. A vault or a possession of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "Every one of the possession valuations, whole rather than a page at a time.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One possession valuation.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always possession_valuation. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "type": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Where the figure comes from: own_estimate, appraisal, insurance_declaration, auction_result, comparable_listing or offer_received."
                                                            },
                                                            "valued_on": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The day the estimate applies to, written as 2026-03-14."
                                                            },
                                                            "confidence": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "How sure somebody is of the figure: unknown, certain, probable or uncertain."
                                                            },
                                                            "amount": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the possession is worth, as a string with two decimals."
                                                            },
                                                            "currency": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The currency of the amount, in lower case. Nothing is ever converted."
                                                            },
                                                            "is_current": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether this valuation gives the current value of the possession: the latest by date, the latest recorded on a tie."
                                                            },
                                                            "valuer": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Who estimated it, as text, or null."
                                                            },
                                                            "method": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "How it was estimated, or null."
                                                            },
                                                            "reference_number": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The reference of the appraisal, the listing or the offer, or null."
                                                            },
                                                            "source_url": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Where the valuation can be checked, or null."
                                                            },
                                                            "note": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Anything worth remembering about the valuation, or null."
                                                            },
                                                            "documents": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "The certificates, listings and offers attached to it, oldest first.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One document.",
                                                                    "properties": {
                                                                        "id": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "format": "uuid",
                                                                            "description": "The id of the file, which is what removing the document takes."
                                                                        },
                                                                        "name": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The name of the file as it was uploaded."
                                                                        },
                                                                        "mime_type": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The kind of the file, such as application/pdf."
                                                                        },
                                                                        "size_in_bytes": {
                                                                            "type": [
                                                                                "integer",
                                                                                "null"
                                                                            ],
                                                                            "description": "How much storage the file takes."
                                                                        }
                                                                    }
                                                                }
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the valuation was recorded, as a count of seconds since 1970. A valuation is never changed, so it has no time of change."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The Valuations section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "possession_valuation",
                                            "id": "3d7b1e94-8a2c-4f60-b5d3-6e19c0a7f248",
                                            "attributes": {
                                                "type": "appraisal",
                                                "valued_on": "2026-03-14",
                                                "confidence": "certain",
                                                "amount": "650.00",
                                                "currency": "usd",
                                                "is_current": true,
                                                "valuer": "Scranton Jewelers",
                                                "method": "Inspection and comparable sales",
                                                "reference_number": "APP-2026-0212",
                                                "source_url": "https://scrantonjewelers.example.com/appraisals/0212",
                                                "note": "Michael insists the gold paint adds to its worth.",
                                                "documents": [
                                                    {
                                                        "id": "6f2a9d48-1c7e-4b35-a8f0-2e5d9b4c7a16",
                                                        "name": "Appraisal certificate.pdf",
                                                        "mime_type": "application/pdf",
                                                        "size_in_bytes": 240000
                                                    }
                                                ],
                                                "created_at": 1773446400
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/valuations/3d7b1e94-8a2c-4f60-b5d3-6e19c0a7f248",
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/valuations"
                                            }
                                        },
                                        {
                                            "type": "possession_valuation",
                                            "id": "b81f5c3a-2d49-4e7b-9a06-f4c8e2d17b53",
                                            "attributes": {
                                                "type": "own_estimate",
                                                "valued_on": "2019-11-20",
                                                "confidence": "uncertain",
                                                "amount": "500.00",
                                                "currency": "usd",
                                                "is_current": false,
                                                "valuer": "Michael Scott",
                                                "method": null,
                                                "reference_number": null,
                                                "source_url": null,
                                                "note": null,
                                                "documents": [],
                                                "created_at": 1761436800
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/valuations/b81f5c3a-2d49-4e7b-9a06-f4c8e2d17b53",
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/valuations"
                                            }
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "post": {
                "operationId": "possession-valuations-create",
                "tags": [
                    "Possession valuations"
                ],
                "summary": "Record a valuation",
                "description": "Record what a possession is worth on a date.\n\nThe type, the date, the amount and its currency are required. There is no endpoint to change a valuation: to correct one, record a new valuation.\n\nDocuments are attached afterwards, one at a time, with the endpoint below. The change is written to the account log.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "type": {
                                        "type": "string",
                                        "description": "Where the figure comes from: own_estimate, appraisal, insurance_declaration, auction_result, comparable_listing or offer_received."
                                    },
                                    "valued_on": {
                                        "type": "string",
                                        "description": "The day the estimate applies to, written as 2026-03-14."
                                    },
                                    "amount": {
                                        "type": "string",
                                        "description": "What the possession is worth. Zero or more, up to 9999999999.99. A figure below zero is refused with “Write an amount of zero or more.”"
                                    },
                                    "currency": {
                                        "type": "string",
                                        "description": "The currency of the amount: usd, eur, gbp, cad, aud, chf, jpy, brl, inr or cny."
                                    },
                                    "confidence": {
                                        "type": "string",
                                        "default": "unknown",
                                        "description": "How sure somebody is of the figure: unknown, certain, probable or uncertain."
                                    },
                                    "valuer": {
                                        "type": "string",
                                        "description": "Who estimated it, up to 255 characters. Markup is stripped."
                                    },
                                    "method": {
                                        "type": "string",
                                        "description": "How it was estimated, up to 255 characters."
                                    },
                                    "reference_number": {
                                        "type": "string",
                                        "description": "The reference of the appraisal, the listing or the offer, up to 255 characters."
                                    },
                                    "source_url": {
                                        "type": "string",
                                        "description": "A full web address where the valuation can be checked, up to 255 characters."
                                    },
                                    "note": {
                                        "type": "string",
                                        "description": "Anything worth remembering about the valuation, up to 5,000 characters."
                                    }
                                },
                                "required": [
                                    "type",
                                    "valued_on",
                                    "amount",
                                    "currency"
                                ]
                            },
                            "example": {
                                "type": "appraisal",
                                "valued_on": "2026-03-14",
                                "amount": 650,
                                "currency": "usd",
                                "confidence": "certain",
                                "valuer": "Scranton Jewelers",
                                "method": "Inspection and comparable sales",
                                "reference_number": "APP-2026-0212",
                                "source_url": "https://scrantonjewelers.example.com/appraisals/0212",
                                "note": "Michael insists the gold paint adds to its worth."
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The valuation object that was recorded.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession valuation.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_valuation. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "type": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the figure comes from: own_estimate, appraisal, insurance_declaration, auction_result, comparable_listing or offer_received."
                                                        },
                                                        "valued_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day the estimate applies to, written as 2026-03-14."
                                                        },
                                                        "confidence": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How sure somebody is of the figure: unknown, certain, probable or uncertain."
                                                        },
                                                        "amount": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the possession is worth, as a string with two decimals."
                                                        },
                                                        "currency": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The currency of the amount, in lower case. Nothing is ever converted."
                                                        },
                                                        "is_current": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether this valuation gives the current value of the possession: the latest by date, the latest recorded on a tie."
                                                        },
                                                        "valuer": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Who estimated it, as text, or null."
                                                        },
                                                        "method": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How it was estimated, or null."
                                                        },
                                                        "reference_number": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The reference of the appraisal, the listing or the offer, or null."
                                                        },
                                                        "source_url": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the valuation can be checked, or null."
                                                        },
                                                        "note": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Anything worth remembering about the valuation, or null."
                                                        },
                                                        "documents": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The certificates, listings and offers attached to it, oldest first."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the valuation was recorded, as a count of seconds since 1970. A valuation is never changed, so it has no time of change."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The Valuations section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_valuation",
                                        "id": "3d7b1e94-8a2c-4f60-b5d3-6e19c0a7f248",
                                        "attributes": {
                                            "type": "appraisal",
                                            "valued_on": "2026-03-14",
                                            "confidence": "certain",
                                            "amount": "650.00",
                                            "currency": "usd",
                                            "is_current": true,
                                            "valuer": "Scranton Jewelers",
                                            "method": "Inspection and comparable sales",
                                            "reference_number": "APP-2026-0212",
                                            "source_url": "https://scrantonjewelers.example.com/appraisals/0212",
                                            "note": "Michael insists the gold paint adds to its worth.",
                                            "documents": [],
                                            "created_at": 1773446400
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/valuations/3d7b1e94-8a2c-4f60-b5d3-6e19c0a7f248",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/valuations"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/possessions/{possession}/valuations/{valuation}": {
            "get": {
                "operationId": "possession-valuations-show",
                "tags": [
                    "Possession valuations"
                ],
                "summary": "Get a valuation",
                "description": "Retrieve one valuation of a possession.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "valuation",
                        "in": "path",
                        "required": true,
                        "description": "The id of the valuation. A valuation of another possession answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A valuation object. A vault, a possession or a valuation of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession valuation.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_valuation. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "type": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the figure comes from: own_estimate, appraisal, insurance_declaration, auction_result, comparable_listing or offer_received."
                                                        },
                                                        "valued_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day the estimate applies to, written as 2026-03-14."
                                                        },
                                                        "confidence": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How sure somebody is of the figure: unknown, certain, probable or uncertain."
                                                        },
                                                        "amount": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the possession is worth, as a string with two decimals."
                                                        },
                                                        "currency": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The currency of the amount, in lower case. Nothing is ever converted."
                                                        },
                                                        "is_current": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether this valuation gives the current value of the possession: the latest by date, the latest recorded on a tie."
                                                        },
                                                        "valuer": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Who estimated it, as text, or null."
                                                        },
                                                        "method": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How it was estimated, or null."
                                                        },
                                                        "reference_number": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The reference of the appraisal, the listing or the offer, or null."
                                                        },
                                                        "source_url": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the valuation can be checked, or null."
                                                        },
                                                        "note": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Anything worth remembering about the valuation, or null."
                                                        },
                                                        "documents": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The certificates, listings and offers attached to it, oldest first.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One document.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the file, which is what removing the document takes."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name of the file as it was uploaded."
                                                                    },
                                                                    "mime_type": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The kind of the file, such as application/pdf."
                                                                    },
                                                                    "size_in_bytes": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "How much storage the file takes."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the valuation was recorded, as a count of seconds since 1970. A valuation is never changed, so it has no time of change."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The Valuations section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_valuation",
                                        "id": "3d7b1e94-8a2c-4f60-b5d3-6e19c0a7f248",
                                        "attributes": {
                                            "type": "appraisal",
                                            "valued_on": "2026-03-14",
                                            "confidence": "certain",
                                            "amount": "650.00",
                                            "currency": "usd",
                                            "is_current": true,
                                            "valuer": "Scranton Jewelers",
                                            "method": "Inspection and comparable sales",
                                            "reference_number": "APP-2026-0212",
                                            "source_url": "https://scrantonjewelers.example.com/appraisals/0212",
                                            "note": "Michael insists the gold paint adds to its worth.",
                                            "documents": [
                                                {
                                                    "id": "6f2a9d48-1c7e-4b35-a8f0-2e5d9b4c7a16",
                                                    "name": "Appraisal certificate.pdf",
                                                    "mime_type": "application/pdf",
                                                    "size_in_bytes": 240000
                                                }
                                            ],
                                            "created_at": 1773446400
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/valuations/3d7b1e94-8a2c-4f60-b5d3-6e19c0a7f248",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/valuations"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "possession-valuations-show-query",
                "tags": [
                    "Possession valuations"
                ],
                "summary": "Get a valuation",
                "description": "Retrieve one valuation of a possession.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "valuation",
                        "in": "path",
                        "required": true,
                        "description": "The id of the valuation. A valuation of another possession answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A valuation object. A vault, a possession or a valuation of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession valuation.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_valuation. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "type": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the figure comes from: own_estimate, appraisal, insurance_declaration, auction_result, comparable_listing or offer_received."
                                                        },
                                                        "valued_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day the estimate applies to, written as 2026-03-14."
                                                        },
                                                        "confidence": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How sure somebody is of the figure: unknown, certain, probable or uncertain."
                                                        },
                                                        "amount": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the possession is worth, as a string with two decimals."
                                                        },
                                                        "currency": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The currency of the amount, in lower case. Nothing is ever converted."
                                                        },
                                                        "is_current": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether this valuation gives the current value of the possession: the latest by date, the latest recorded on a tie."
                                                        },
                                                        "valuer": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Who estimated it, as text, or null."
                                                        },
                                                        "method": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How it was estimated, or null."
                                                        },
                                                        "reference_number": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The reference of the appraisal, the listing or the offer, or null."
                                                        },
                                                        "source_url": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the valuation can be checked, or null."
                                                        },
                                                        "note": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Anything worth remembering about the valuation, or null."
                                                        },
                                                        "documents": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The certificates, listings and offers attached to it, oldest first.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One document.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the file, which is what removing the document takes."
                                                                    },
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name of the file as it was uploaded."
                                                                    },
                                                                    "mime_type": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The kind of the file, such as application/pdf."
                                                                    },
                                                                    "size_in_bytes": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "How much storage the file takes."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the valuation was recorded, as a count of seconds since 1970. A valuation is never changed, so it has no time of change."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The Valuations section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_valuation",
                                        "id": "3d7b1e94-8a2c-4f60-b5d3-6e19c0a7f248",
                                        "attributes": {
                                            "type": "appraisal",
                                            "valued_on": "2026-03-14",
                                            "confidence": "certain",
                                            "amount": "650.00",
                                            "currency": "usd",
                                            "is_current": true,
                                            "valuer": "Scranton Jewelers",
                                            "method": "Inspection and comparable sales",
                                            "reference_number": "APP-2026-0212",
                                            "source_url": "https://scrantonjewelers.example.com/appraisals/0212",
                                            "note": "Michael insists the gold paint adds to its worth.",
                                            "documents": [
                                                {
                                                    "id": "6f2a9d48-1c7e-4b35-a8f0-2e5d9b4c7a16",
                                                    "name": "Appraisal certificate.pdf",
                                                    "mime_type": "application/pdf",
                                                    "size_in_bytes": 240000
                                                }
                                            ],
                                            "created_at": 1773446400
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/valuations/3d7b1e94-8a2c-4f60-b5d3-6e19c0a7f248",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/valuations"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "delete": {
                "operationId": "possession-valuations-destroy",
                "tags": [
                    "Possession valuations"
                ],
                "summary": "Delete a valuation",
                "description": "Delete a valuation of a possession.\n\nThe deletion is final. When the valuation gave the current value, the latest one left gives it instead. Its documents are let go and swept up after a grace period once nothing uses them. The account log keeps the name of the possession.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "valuation",
                        "in": "path",
                        "required": true,
                        "description": "The id of the valuation. A valuation of another possession answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Nothing. A valuation of another possession or of another account answers 404."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/possessions/{possession}/valuations/{valuation}/documents/{file}": {
            "delete": {
                "operationId": "possession-valuation-documents-destroy",
                "tags": [
                    "Possession valuations"
                ],
                "summary": "Remove a document from a valuation",
                "description": "Remove a document from a valuation. The change is written to the account log.\n\nThe file is let go rather than deleted outright. It stays wherever else it is used, and is swept up after a grace period once nothing uses it.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "valuation",
                        "in": "path",
                        "required": true,
                        "description": "The id of the valuation. A valuation of another possession answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "file",
                        "in": "path",
                        "required": true,
                        "description": "The id of the document, as the documents of the valuation give it. A document of another valuation answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Nothing. A valuation of another possession, a document of another valuation or of another account answers 404."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/possessions/{possession}/provenance": {
            "get": {
                "operationId": "possession-provenance-index",
                "tags": [
                    "Possession provenance"
                ],
                "summary": "List the provenance of a possession",
                "description": "List every provenance event of a possession, oldest first.\n\nEvents with an unknown date come last. On the same date, the earliest recorded comes first. The list is whole rather than paginated.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Every provenance event object of the possession, or an empty list. A vault or a possession of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "Every one of the possession provenance events, whole rather than a page at a time.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One possession provenance event.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always possession_provenance_event. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "type": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What happened: origin, acquisition, inheritance, gift, sale, custody, loss, recovery, authentication, exhibition, publication or other."
                                                            },
                                                            "group": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The group the type belongs to: ownership, custody or authenticity."
                                                            },
                                                            "title": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What happened in a few words, or null, in which case the application shows the name of the type."
                                                            },
                                                            "date_precision": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "How much of the date is known: day, month, year, circa or unknown."
                                                            },
                                                            "occurred_on": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "When it happened, in the shape its precision gives: 1980-01-20 for a day, 1980-01 for a month, 1980 for a year or around a year, null when unknown."
                                                            },
                                                            "from": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Who it came from, as text, or null."
                                                            },
                                                            "to": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Who held it afterwards, as text, or null."
                                                            },
                                                            "location": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Where it happened, as text, or null."
                                                            },
                                                            "description": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What happened and how it is known, or null."
                                                            },
                                                            "reference_number": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The reference of the record (a lot, a deed, a certificate), or null."
                                                            },
                                                            "source_url": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Where the event can be checked, or null."
                                                            },
                                                            "is_verified": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether a document, a record or an expert confirms the event."
                                                            },
                                                            "transaction_id": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "format": "uuid",
                                                                "description": "The id of the transaction of the same possession that records what the moment cost, or null. An event holds no money of its own."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the event was recorded, as a count of seconds since 1970."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The Provenance section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "possession_provenance_event",
                                            "id": "8a3f2d15-6c94-4e70-b1d8-3f5a9c2e7b41",
                                            "attributes": {
                                                "type": "origin",
                                                "group": "ownership",
                                                "title": "Built by Grandfather Schrute",
                                                "date_precision": "circa",
                                                "occurred_on": "1921",
                                                "from": null,
                                                "to": "Dwight Schrute Sr.",
                                                "location": "Honesdale",
                                                "description": "Mose remembers the cart it came on. No record has been found.",
                                                "reference_number": null,
                                                "source_url": null,
                                                "is_verified": false,
                                                "transaction_id": null,
                                                "created_at": 1773446400
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/schrute-farms/possessions/5e1b7c93-4a28-4d6f-9b02-7c3e8a1f4d60/provenance/8a3f2d15-6c94-4e70-b1d8-3f5a9c2e7b41",
                                                "web": "https://my.monicahq.com/vaults/schrute-farms/possessions/5e1b7c93-4a28-4d6f-9b02-7c3e8a1f4d60/provenance"
                                            }
                                        },
                                        {
                                            "type": "possession_provenance_event",
                                            "id": "c47e9b20-1d53-4a8f-9e6c-2b8d5f1a3e97",
                                            "attributes": {
                                                "type": "gift",
                                                "group": "ownership",
                                                "title": "Given to Dwight for his tenth birthday",
                                                "date_precision": "day",
                                                "occurred_on": "1980-01-20",
                                                "from": "Dwight Schrute Sr.",
                                                "to": "Dwight Schrute",
                                                "location": "Schrute Farms",
                                                "description": null,
                                                "reference_number": "Family ledger, page 12",
                                                "source_url": null,
                                                "is_verified": true,
                                                "transaction_id": "2f6d8a41-9b37-4c05-a7e2-5d1c3b9f8e64",
                                                "created_at": 1773450000
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/schrute-farms/possessions/5e1b7c93-4a28-4d6f-9b02-7c3e8a1f4d60/provenance/c47e9b20-1d53-4a8f-9e6c-2b8d5f1a3e97",
                                                "web": "https://my.monicahq.com/vaults/schrute-farms/possessions/5e1b7c93-4a28-4d6f-9b02-7c3e8a1f4d60/provenance"
                                            }
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "possession-provenance-index-query",
                "tags": [
                    "Possession provenance"
                ],
                "summary": "List the provenance of a possession",
                "description": "List every provenance event of a possession, oldest first.\n\nEvents with an unknown date come last. On the same date, the earliest recorded comes first. The list is whole rather than paginated.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Every provenance event object of the possession, or an empty list. A vault or a possession of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "Every one of the possession provenance events, whole rather than a page at a time.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One possession provenance event.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always possession_provenance_event. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "type": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What happened: origin, acquisition, inheritance, gift, sale, custody, loss, recovery, authentication, exhibition, publication or other."
                                                            },
                                                            "group": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The group the type belongs to: ownership, custody or authenticity."
                                                            },
                                                            "title": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What happened in a few words, or null, in which case the application shows the name of the type."
                                                            },
                                                            "date_precision": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "How much of the date is known: day, month, year, circa or unknown."
                                                            },
                                                            "occurred_on": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "When it happened, in the shape its precision gives: 1980-01-20 for a day, 1980-01 for a month, 1980 for a year or around a year, null when unknown."
                                                            },
                                                            "from": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Who it came from, as text, or null."
                                                            },
                                                            "to": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Who held it afterwards, as text, or null."
                                                            },
                                                            "location": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Where it happened, as text, or null."
                                                            },
                                                            "description": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What happened and how it is known, or null."
                                                            },
                                                            "reference_number": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The reference of the record (a lot, a deed, a certificate), or null."
                                                            },
                                                            "source_url": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Where the event can be checked, or null."
                                                            },
                                                            "is_verified": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether a document, a record or an expert confirms the event."
                                                            },
                                                            "transaction_id": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "format": "uuid",
                                                                "description": "The id of the transaction of the same possession that records what the moment cost, or null. An event holds no money of its own."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the event was recorded, as a count of seconds since 1970."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The Provenance section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "possession_provenance_event",
                                            "id": "8a3f2d15-6c94-4e70-b1d8-3f5a9c2e7b41",
                                            "attributes": {
                                                "type": "origin",
                                                "group": "ownership",
                                                "title": "Built by Grandfather Schrute",
                                                "date_precision": "circa",
                                                "occurred_on": "1921",
                                                "from": null,
                                                "to": "Dwight Schrute Sr.",
                                                "location": "Honesdale",
                                                "description": "Mose remembers the cart it came on. No record has been found.",
                                                "reference_number": null,
                                                "source_url": null,
                                                "is_verified": false,
                                                "transaction_id": null,
                                                "created_at": 1773446400
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/schrute-farms/possessions/5e1b7c93-4a28-4d6f-9b02-7c3e8a1f4d60/provenance/8a3f2d15-6c94-4e70-b1d8-3f5a9c2e7b41",
                                                "web": "https://my.monicahq.com/vaults/schrute-farms/possessions/5e1b7c93-4a28-4d6f-9b02-7c3e8a1f4d60/provenance"
                                            }
                                        },
                                        {
                                            "type": "possession_provenance_event",
                                            "id": "c47e9b20-1d53-4a8f-9e6c-2b8d5f1a3e97",
                                            "attributes": {
                                                "type": "gift",
                                                "group": "ownership",
                                                "title": "Given to Dwight for his tenth birthday",
                                                "date_precision": "day",
                                                "occurred_on": "1980-01-20",
                                                "from": "Dwight Schrute Sr.",
                                                "to": "Dwight Schrute",
                                                "location": "Schrute Farms",
                                                "description": null,
                                                "reference_number": "Family ledger, page 12",
                                                "source_url": null,
                                                "is_verified": true,
                                                "transaction_id": "2f6d8a41-9b37-4c05-a7e2-5d1c3b9f8e64",
                                                "created_at": 1773450000
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/schrute-farms/possessions/5e1b7c93-4a28-4d6f-9b02-7c3e8a1f4d60/provenance/c47e9b20-1d53-4a8f-9e6c-2b8d5f1a3e97",
                                                "web": "https://my.monicahq.com/vaults/schrute-farms/possessions/5e1b7c93-4a28-4d6f-9b02-7c3e8a1f4d60/provenance"
                                            }
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "post": {
                "operationId": "possession-provenance-create",
                "tags": [
                    "Possession provenance"
                ],
                "summary": "Record a provenance event",
                "description": "Record one moment in the provenance of a possession.\n\nOnly the type is required. The change is written to the account log.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "type": {
                                        "type": "string",
                                        "description": "What happened: origin, acquisition, inheritance, gift, sale, custody, loss, recovery, authentication, exhibition, publication or other."
                                    },
                                    "date_precision": {
                                        "type": "string",
                                        "default": "day",
                                        "description": "How much of the date is known: day, month, year, circa or unknown."
                                    },
                                    "occurred_on": {
                                        "type": "string",
                                        "description": "When it happened, in the shape its precision gives: 1980-01-20, 1980-01 or 1980. A date in another shape is refused with “Write the date in the shape its precision asks for.” Ignored when the precision is unknown."
                                    },
                                    "title": {
                                        "type": "string",
                                        "description": "What happened in a few words, up to 255 characters. Markup is stripped."
                                    },
                                    "from": {
                                        "type": "string",
                                        "description": "Who it came from, up to 255 characters."
                                    },
                                    "to": {
                                        "type": "string",
                                        "description": "Who held it afterwards, up to 255 characters."
                                    },
                                    "location": {
                                        "type": "string",
                                        "description": "Where it happened, up to 255 characters."
                                    },
                                    "description": {
                                        "type": "string",
                                        "description": "What happened and how it is known, up to 5,000 characters."
                                    },
                                    "reference_number": {
                                        "type": "string",
                                        "description": "The reference of the record, up to 255 characters."
                                    },
                                    "source_url": {
                                        "type": "string",
                                        "description": "A full web address where the event can be checked, up to 255 characters."
                                    },
                                    "transaction_id": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "The id of a transaction of the same possession that records what the moment cost. A transaction of another possession answers 422."
                                    },
                                    "is_verified": {
                                        "type": "boolean",
                                        "default": false,
                                        "description": "Whether a document, a record or an expert confirms the event."
                                    }
                                },
                                "required": [
                                    "type"
                                ]
                            },
                            "example": {
                                "type": "gift",
                                "date_precision": "day",
                                "occurred_on": "1980-01-20",
                                "title": "Given to Dwight for his tenth birthday",
                                "from": "Dwight Schrute Sr.",
                                "to": "Dwight Schrute",
                                "location": "Schrute Farms",
                                "reference_number": "Family ledger, page 12",
                                "transaction_id": "2f6d8a41-9b37-4c05-a7e2-5d1c3b9f8e64",
                                "is_verified": true
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The provenance event object that was recorded.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession provenance event.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_provenance_event. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "type": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What happened: origin, acquisition, inheritance, gift, sale, custody, loss, recovery, authentication, exhibition, publication or other."
                                                        },
                                                        "group": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The group the type belongs to: ownership, custody or authenticity."
                                                        },
                                                        "title": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What happened in a few words, or null, in which case the application shows the name of the type."
                                                        },
                                                        "date_precision": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How much of the date is known: day, month, year, circa or unknown."
                                                        },
                                                        "occurred_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "When it happened, in the shape its precision gives: 1980-01-20 for a day, 1980-01 for a month, 1980 for a year or around a year, null when unknown."
                                                        },
                                                        "from": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Who it came from, as text, or null."
                                                        },
                                                        "to": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Who held it afterwards, as text, or null."
                                                        },
                                                        "location": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where it happened, as text, or null."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What happened and how it is known, or null."
                                                        },
                                                        "reference_number": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The reference of the record (a lot, a deed, a certificate), or null."
                                                        },
                                                        "source_url": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the event can be checked, or null."
                                                        },
                                                        "is_verified": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether a document, a record or an expert confirms the event."
                                                        },
                                                        "transaction_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The id of the transaction of the same possession that records what the moment cost, or null. An event holds no money of its own."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the event was recorded, as a count of seconds since 1970."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The Provenance section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_provenance_event",
                                        "id": "c47e9b20-1d53-4a8f-9e6c-2b8d5f1a3e97",
                                        "attributes": {
                                            "type": "gift",
                                            "group": "ownership",
                                            "title": "Given to Dwight for his tenth birthday",
                                            "date_precision": "day",
                                            "occurred_on": "1980-01-20",
                                            "from": "Dwight Schrute Sr.",
                                            "to": "Dwight Schrute",
                                            "location": "Schrute Farms",
                                            "description": null,
                                            "reference_number": "Family ledger, page 12",
                                            "source_url": null,
                                            "is_verified": true,
                                            "transaction_id": "2f6d8a41-9b37-4c05-a7e2-5d1c3b9f8e64",
                                            "created_at": 1773450000
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/schrute-farms/possessions/5e1b7c93-4a28-4d6f-9b02-7c3e8a1f4d60/provenance/c47e9b20-1d53-4a8f-9e6c-2b8d5f1a3e97",
                                            "web": "https://my.monicahq.com/vaults/schrute-farms/possessions/5e1b7c93-4a28-4d6f-9b02-7c3e8a1f4d60/provenance"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/possessions/{possession}/provenance/{event}": {
            "get": {
                "operationId": "possession-provenance-show",
                "tags": [
                    "Possession provenance"
                ],
                "summary": "Get a provenance event",
                "description": "Retrieve one provenance event of a possession.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "event",
                        "in": "path",
                        "required": true,
                        "description": "The id of the event. An event of another possession answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A provenance event object. A vault, a possession or an event of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession provenance event.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_provenance_event. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "type": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What happened: origin, acquisition, inheritance, gift, sale, custody, loss, recovery, authentication, exhibition, publication or other."
                                                        },
                                                        "group": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The group the type belongs to: ownership, custody or authenticity."
                                                        },
                                                        "title": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What happened in a few words, or null, in which case the application shows the name of the type."
                                                        },
                                                        "date_precision": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How much of the date is known: day, month, year, circa or unknown."
                                                        },
                                                        "occurred_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "When it happened, in the shape its precision gives: 1980-01-20 for a day, 1980-01 for a month, 1980 for a year or around a year, null when unknown."
                                                        },
                                                        "from": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Who it came from, as text, or null."
                                                        },
                                                        "to": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Who held it afterwards, as text, or null."
                                                        },
                                                        "location": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where it happened, as text, or null."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What happened and how it is known, or null."
                                                        },
                                                        "reference_number": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The reference of the record (a lot, a deed, a certificate), or null."
                                                        },
                                                        "source_url": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the event can be checked, or null."
                                                        },
                                                        "is_verified": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether a document, a record or an expert confirms the event."
                                                        },
                                                        "transaction_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The id of the transaction of the same possession that records what the moment cost, or null. An event holds no money of its own."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the event was recorded, as a count of seconds since 1970."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The Provenance section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_provenance_event",
                                        "id": "c47e9b20-1d53-4a8f-9e6c-2b8d5f1a3e97",
                                        "attributes": {
                                            "type": "gift",
                                            "group": "ownership",
                                            "title": "Given to Dwight for his tenth birthday",
                                            "date_precision": "day",
                                            "occurred_on": "1980-01-20",
                                            "from": "Dwight Schrute Sr.",
                                            "to": "Dwight Schrute",
                                            "location": "Schrute Farms",
                                            "description": null,
                                            "reference_number": "Family ledger, page 12",
                                            "source_url": null,
                                            "is_verified": true,
                                            "transaction_id": "2f6d8a41-9b37-4c05-a7e2-5d1c3b9f8e64",
                                            "created_at": 1773450000
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/schrute-farms/possessions/5e1b7c93-4a28-4d6f-9b02-7c3e8a1f4d60/provenance/c47e9b20-1d53-4a8f-9e6c-2b8d5f1a3e97",
                                            "web": "https://my.monicahq.com/vaults/schrute-farms/possessions/5e1b7c93-4a28-4d6f-9b02-7c3e8a1f4d60/provenance"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "possession-provenance-show-query",
                "tags": [
                    "Possession provenance"
                ],
                "summary": "Get a provenance event",
                "description": "Retrieve one provenance event of a possession.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "event",
                        "in": "path",
                        "required": true,
                        "description": "The id of the event. An event of another possession answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A provenance event object. A vault, a possession or an event of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession provenance event.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_provenance_event. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "type": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What happened: origin, acquisition, inheritance, gift, sale, custody, loss, recovery, authentication, exhibition, publication or other."
                                                        },
                                                        "group": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The group the type belongs to: ownership, custody or authenticity."
                                                        },
                                                        "title": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What happened in a few words, or null, in which case the application shows the name of the type."
                                                        },
                                                        "date_precision": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How much of the date is known: day, month, year, circa or unknown."
                                                        },
                                                        "occurred_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "When it happened, in the shape its precision gives: 1980-01-20 for a day, 1980-01 for a month, 1980 for a year or around a year, null when unknown."
                                                        },
                                                        "from": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Who it came from, as text, or null."
                                                        },
                                                        "to": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Who held it afterwards, as text, or null."
                                                        },
                                                        "location": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where it happened, as text, or null."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What happened and how it is known, or null."
                                                        },
                                                        "reference_number": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The reference of the record (a lot, a deed, a certificate), or null."
                                                        },
                                                        "source_url": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the event can be checked, or null."
                                                        },
                                                        "is_verified": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether a document, a record or an expert confirms the event."
                                                        },
                                                        "transaction_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The id of the transaction of the same possession that records what the moment cost, or null. An event holds no money of its own."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the event was recorded, as a count of seconds since 1970."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The Provenance section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_provenance_event",
                                        "id": "c47e9b20-1d53-4a8f-9e6c-2b8d5f1a3e97",
                                        "attributes": {
                                            "type": "gift",
                                            "group": "ownership",
                                            "title": "Given to Dwight for his tenth birthday",
                                            "date_precision": "day",
                                            "occurred_on": "1980-01-20",
                                            "from": "Dwight Schrute Sr.",
                                            "to": "Dwight Schrute",
                                            "location": "Schrute Farms",
                                            "description": null,
                                            "reference_number": "Family ledger, page 12",
                                            "source_url": null,
                                            "is_verified": true,
                                            "transaction_id": "2f6d8a41-9b37-4c05-a7e2-5d1c3b9f8e64",
                                            "created_at": 1773450000
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/schrute-farms/possessions/5e1b7c93-4a28-4d6f-9b02-7c3e8a1f4d60/provenance/c47e9b20-1d53-4a8f-9e6c-2b8d5f1a3e97",
                                            "web": "https://my.monicahq.com/vaults/schrute-farms/possessions/5e1b7c93-4a28-4d6f-9b02-7c3e8a1f4d60/provenance"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "put": {
                "operationId": "possession-provenance-update",
                "tags": [
                    "Possession provenance"
                ],
                "summary": "Update a provenance event",
                "description": "Change a provenance event of a possession.\n\nWhat you leave out keeps its value, and what you send as null is cleared. When the precision changes and no date is sent, the date is kept in the shape of the new precision. The change is written to the account log.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "event",
                        "in": "path",
                        "required": true,
                        "description": "The id of the event. An event of another possession answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "type": {
                                        "type": "string",
                                        "description": "What happened: origin, acquisition, inheritance, gift, sale, custody, loss, recovery, authentication, exhibition, publication or other."
                                    },
                                    "date_precision": {
                                        "type": "string",
                                        "description": "How much of the date is known: day, month, year, circa or unknown."
                                    },
                                    "occurred_on": {
                                        "type": "string",
                                        "description": "When it happened, in the shape its precision gives: 1980-01-20, 1980-01 or 1980. A date in another shape is refused with “Write the date in the shape its precision asks for.” Ignored when the precision is unknown."
                                    },
                                    "title": {
                                        "type": "string",
                                        "description": "What happened in a few words, up to 255 characters. Markup is stripped."
                                    },
                                    "from": {
                                        "type": "string",
                                        "description": "Who it came from, up to 255 characters."
                                    },
                                    "to": {
                                        "type": "string",
                                        "description": "Who held it afterwards, up to 255 characters."
                                    },
                                    "location": {
                                        "type": "string",
                                        "description": "Where it happened, up to 255 characters."
                                    },
                                    "description": {
                                        "type": "string",
                                        "description": "What happened and how it is known, up to 5,000 characters."
                                    },
                                    "reference_number": {
                                        "type": "string",
                                        "description": "The reference of the record, up to 255 characters."
                                    },
                                    "source_url": {
                                        "type": "string",
                                        "description": "A full web address where the event can be checked, up to 255 characters."
                                    },
                                    "transaction_id": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "The id of a transaction of the same possession that records what the moment cost. A transaction of another possession answers 422."
                                    },
                                    "is_verified": {
                                        "type": "boolean",
                                        "description": "Whether a document, a record or an expert confirms the event."
                                    }
                                }
                            },
                            "example": {
                                "type": "gift",
                                "date_precision": "day",
                                "occurred_on": "1980-01-20",
                                "title": "Given to Dwight for his tenth birthday",
                                "from": "Dwight Schrute Sr.",
                                "to": "Dwight Schrute",
                                "location": "Schrute Farms",
                                "reference_number": "Family ledger, page 12",
                                "transaction_id": "2f6d8a41-9b37-4c05-a7e2-5d1c3b9f8e64",
                                "is_verified": true
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The provenance event object, as it now stands. An event of another possession or of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession provenance event.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_provenance_event. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "type": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What happened: origin, acquisition, inheritance, gift, sale, custody, loss, recovery, authentication, exhibition, publication or other."
                                                        },
                                                        "group": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The group the type belongs to: ownership, custody or authenticity."
                                                        },
                                                        "title": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What happened in a few words, or null, in which case the application shows the name of the type."
                                                        },
                                                        "date_precision": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "How much of the date is known: day, month, year, circa or unknown."
                                                        },
                                                        "occurred_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "When it happened, in the shape its precision gives: 1980-01-20 for a day, 1980-01 for a month, 1980 for a year or around a year, null when unknown."
                                                        },
                                                        "from": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Who it came from, as text, or null."
                                                        },
                                                        "to": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Who held it afterwards, as text, or null."
                                                        },
                                                        "location": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where it happened, as text, or null."
                                                        },
                                                        "description": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What happened and how it is known, or null."
                                                        },
                                                        "reference_number": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The reference of the record (a lot, a deed, a certificate), or null."
                                                        },
                                                        "source_url": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Where the event can be checked, or null."
                                                        },
                                                        "is_verified": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether a document, a record or an expert confirms the event."
                                                        },
                                                        "transaction_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The id of the transaction of the same possession that records what the moment cost, or null. An event holds no money of its own."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the event was recorded, as a count of seconds since 1970."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The Provenance section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_provenance_event",
                                        "id": "c47e9b20-1d53-4a8f-9e6c-2b8d5f1a3e97",
                                        "attributes": {
                                            "type": "gift",
                                            "group": "ownership",
                                            "title": "Given to Dwight for his tenth birthday",
                                            "date_precision": "day",
                                            "occurred_on": "1980-01-20",
                                            "from": "Dwight Schrute Sr.",
                                            "to": "Dwight Schrute",
                                            "location": "Schrute Farms",
                                            "description": null,
                                            "reference_number": "Family ledger, page 12",
                                            "source_url": null,
                                            "is_verified": true,
                                            "transaction_id": "2f6d8a41-9b37-4c05-a7e2-5d1c3b9f8e64",
                                            "created_at": 1773450000
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/schrute-farms/possessions/5e1b7c93-4a28-4d6f-9b02-7c3e8a1f4d60/provenance/c47e9b20-1d53-4a8f-9e6c-2b8d5f1a3e97",
                                            "web": "https://my.monicahq.com/vaults/schrute-farms/possessions/5e1b7c93-4a28-4d6f-9b02-7c3e8a1f4d60/provenance"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "delete": {
                "operationId": "possession-provenance-destroy",
                "tags": [
                    "Possession provenance"
                ],
                "summary": "Delete a provenance event",
                "description": "Delete a provenance event of a possession.\n\nThe deletion is final. The transaction the event points at, if any, stays. The account log keeps the name of the possession.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "event",
                        "in": "path",
                        "required": true,
                        "description": "The id of the event. An event of another possession answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Nothing. An event of another possession or of another account answers 404."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/possessions/{possession}/location-stays": {
            "get": {
                "operationId": "possession-location-stays-index",
                "tags": [
                    "Possession locations"
                ],
                "summary": "List the stays of a possession",
                "description": "List every stay of a possession, oldest first.\n\nStays whose arrival is unknown come first. On the same day, the earliest recorded comes first. The list is whole rather than paginated.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Every stay object of the possession, or an empty list. A vault or a possession of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "Every one of the possession location stays, whole rather than a page at a time.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One possession location stay.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always possession_location_stay. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "location_id": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "format": "uuid",
                                                                "description": "The id of the location of the account where the possession stayed. Its full path comes from the locations endpoints."
                                                            },
                                                            "location_name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The name of that location, without the locations around it."
                                                            },
                                                            "arrived_on": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The day it arrived, as YYYY-MM-DD, or null when the day is unknown."
                                                            },
                                                            "left_on": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The day it left, as YYYY-MM-DD, or null on the stay where it is now."
                                                            },
                                                            "is_current": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether it is the open stay, where the possession is now. A possession has at most one."
                                                            },
                                                            "reason": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Why it went there, or null."
                                                            },
                                                            "note": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Anything worth knowing about the stay, or null."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the stay was recorded, as a count of seconds since 1970."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The Locations section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "possession_location_stay",
                                            "id": "3b9e4f27-8d61-4c0a-a5f3-1e7c2d9b6a48",
                                            "attributes": {
                                                "location_id": "9c4a1e7f-2b58-4d36-8e09-5f3b7a1c6d24",
                                                "location_name": "Barn",
                                                "arrived_on": "2019-11-08",
                                                "left_on": "2024-06-04",
                                                "is_current": false,
                                                "reason": "After the harvest",
                                                "note": null,
                                                "created_at": 1773446400
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/schrute-farms/possessions/5e1b7c93-4a28-4d6f-9b02-7c3e8a1f4d60/location-stays/3b9e4f27-8d61-4c0a-a5f3-1e7c2d9b6a48",
                                                "web": "https://my.monicahq.com/vaults/schrute-farms/possessions/5e1b7c93-4a28-4d6f-9b02-7c3e8a1f4d60/locations"
                                            }
                                        },
                                        {
                                            "type": "possession_location_stay",
                                            "id": "f1d72a8c-5e39-4b16-9c04-7a3e6b2d8f15",
                                            "attributes": {
                                                "location_id": "6e2f8b31-7c4d-4a95-b1e8-3d9c5a7f2e60",
                                                "location_name": "Cellar",
                                                "arrived_on": "2024-06-04",
                                                "left_on": null,
                                                "is_current": true,
                                                "reason": "Harvest season",
                                                "note": "Mose carried it down.",
                                                "created_at": 1773450000
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/schrute-farms/possessions/5e1b7c93-4a28-4d6f-9b02-7c3e8a1f4d60/location-stays/f1d72a8c-5e39-4b16-9c04-7a3e6b2d8f15",
                                                "web": "https://my.monicahq.com/vaults/schrute-farms/possessions/5e1b7c93-4a28-4d6f-9b02-7c3e8a1f4d60/locations"
                                            }
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "possession-location-stays-index-query",
                "tags": [
                    "Possession locations"
                ],
                "summary": "List the stays of a possession",
                "description": "List every stay of a possession, oldest first.\n\nStays whose arrival is unknown come first. On the same day, the earliest recorded comes first. The list is whole rather than paginated.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Every stay object of the possession, or an empty list. A vault or a possession of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "Every one of the possession location stays, whole rather than a page at a time.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One possession location stay.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always possession_location_stay. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "location_id": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "format": "uuid",
                                                                "description": "The id of the location of the account where the possession stayed. Its full path comes from the locations endpoints."
                                                            },
                                                            "location_name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The name of that location, without the locations around it."
                                                            },
                                                            "arrived_on": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The day it arrived, as YYYY-MM-DD, or null when the day is unknown."
                                                            },
                                                            "left_on": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The day it left, as YYYY-MM-DD, or null on the stay where it is now."
                                                            },
                                                            "is_current": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether it is the open stay, where the possession is now. A possession has at most one."
                                                            },
                                                            "reason": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Why it went there, or null."
                                                            },
                                                            "note": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Anything worth knowing about the stay, or null."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the stay was recorded, as a count of seconds since 1970."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The Locations section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "possession_location_stay",
                                            "id": "3b9e4f27-8d61-4c0a-a5f3-1e7c2d9b6a48",
                                            "attributes": {
                                                "location_id": "9c4a1e7f-2b58-4d36-8e09-5f3b7a1c6d24",
                                                "location_name": "Barn",
                                                "arrived_on": "2019-11-08",
                                                "left_on": "2024-06-04",
                                                "is_current": false,
                                                "reason": "After the harvest",
                                                "note": null,
                                                "created_at": 1773446400
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/schrute-farms/possessions/5e1b7c93-4a28-4d6f-9b02-7c3e8a1f4d60/location-stays/3b9e4f27-8d61-4c0a-a5f3-1e7c2d9b6a48",
                                                "web": "https://my.monicahq.com/vaults/schrute-farms/possessions/5e1b7c93-4a28-4d6f-9b02-7c3e8a1f4d60/locations"
                                            }
                                        },
                                        {
                                            "type": "possession_location_stay",
                                            "id": "f1d72a8c-5e39-4b16-9c04-7a3e6b2d8f15",
                                            "attributes": {
                                                "location_id": "6e2f8b31-7c4d-4a95-b1e8-3d9c5a7f2e60",
                                                "location_name": "Cellar",
                                                "arrived_on": "2024-06-04",
                                                "left_on": null,
                                                "is_current": true,
                                                "reason": "Harvest season",
                                                "note": "Mose carried it down.",
                                                "created_at": 1773450000
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/schrute-farms/possessions/5e1b7c93-4a28-4d6f-9b02-7c3e8a1f4d60/location-stays/f1d72a8c-5e39-4b16-9c04-7a3e6b2d8f15",
                                                "web": "https://my.monicahq.com/vaults/schrute-farms/possessions/5e1b7c93-4a28-4d6f-9b02-7c3e8a1f4d60/locations"
                                            }
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "post": {
                "operationId": "possession-location-stays-create",
                "tags": [
                    "Possession locations"
                ],
                "summary": "Move a possession",
                "description": "Move a possession to another location of the account on a given day.\n\nThe stay where it is now closes on that day, and a new stay opens at the location on the same day. The possession then reports that location as where it is. The change is written to the account log.\n\nA possession that is sold, given away, thrown away, lost or stolen answers 422 on location_id (\"This possession is no longer in your hands, so it cannot be moved.\"). The location it is already in answers 422 on location_id (\"It is already in Barn.\"). A day before the current stay began answers 422 on moved_on (\"The current stay began on 8 November 2019. Date the move after that, or correct the current stay instead.\").\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "location_id": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "The id of a location of the account. A location of another account answers 422."
                                    },
                                    "moved_on": {
                                        "type": "string",
                                        "description": "The day it moved, as YYYY-MM-DD."
                                    },
                                    "reason": {
                                        "type": "string",
                                        "description": "Why it moved, up to 255 characters. Markup is stripped."
                                    },
                                    "note": {
                                        "type": "string",
                                        "description": "Anything worth knowing about the new stay, up to 5,000 characters."
                                    }
                                },
                                "required": [
                                    "location_id",
                                    "moved_on"
                                ]
                            },
                            "example": {
                                "location_id": "6e2f8b31-7c4d-4a95-b1e8-3d9c5a7f2e60",
                                "moved_on": "2024-06-04",
                                "reason": "Harvest season",
                                "note": "Mose carried it down."
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The new stay object, where the possession is now.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession location stay.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_location_stay. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "location_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The id of the location of the account where the possession stayed. Its full path comes from the locations endpoints."
                                                        },
                                                        "location_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The name of that location, without the locations around it."
                                                        },
                                                        "arrived_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day it arrived, as YYYY-MM-DD, or null when the day is unknown."
                                                        },
                                                        "left_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day it left, as YYYY-MM-DD, or null on the stay where it is now."
                                                        },
                                                        "is_current": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether it is the open stay, where the possession is now. A possession has at most one."
                                                        },
                                                        "reason": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Why it went there, or null."
                                                        },
                                                        "note": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Anything worth knowing about the stay, or null."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the stay was recorded, as a count of seconds since 1970."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The Locations section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_location_stay",
                                        "id": "f1d72a8c-5e39-4b16-9c04-7a3e6b2d8f15",
                                        "attributes": {
                                            "location_id": "6e2f8b31-7c4d-4a95-b1e8-3d9c5a7f2e60",
                                            "location_name": "Cellar",
                                            "arrived_on": "2024-06-04",
                                            "left_on": null,
                                            "is_current": true,
                                            "reason": "Harvest season",
                                            "note": "Mose carried it down.",
                                            "created_at": 1773450000
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/schrute-farms/possessions/5e1b7c93-4a28-4d6f-9b02-7c3e8a1f4d60/location-stays/f1d72a8c-5e39-4b16-9c04-7a3e6b2d8f15",
                                            "web": "https://my.monicahq.com/vaults/schrute-farms/possessions/5e1b7c93-4a28-4d6f-9b02-7c3e8a1f4d60/locations"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/possessions/{possession}/location-stays/{stay}": {
            "get": {
                "operationId": "possession-location-stays-show",
                "tags": [
                    "Possession locations"
                ],
                "summary": "Get a stay",
                "description": "Retrieve one stay of a possession.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "stay",
                        "in": "path",
                        "required": true,
                        "description": "The id of the stay. A stay of another possession answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A stay object. A vault, a possession or a stay of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession location stay.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_location_stay. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "location_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The id of the location of the account where the possession stayed. Its full path comes from the locations endpoints."
                                                        },
                                                        "location_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The name of that location, without the locations around it."
                                                        },
                                                        "arrived_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day it arrived, as YYYY-MM-DD, or null when the day is unknown."
                                                        },
                                                        "left_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day it left, as YYYY-MM-DD, or null on the stay where it is now."
                                                        },
                                                        "is_current": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether it is the open stay, where the possession is now. A possession has at most one."
                                                        },
                                                        "reason": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Why it went there, or null."
                                                        },
                                                        "note": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Anything worth knowing about the stay, or null."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the stay was recorded, as a count of seconds since 1970."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The Locations section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_location_stay",
                                        "id": "f1d72a8c-5e39-4b16-9c04-7a3e6b2d8f15",
                                        "attributes": {
                                            "location_id": "6e2f8b31-7c4d-4a95-b1e8-3d9c5a7f2e60",
                                            "location_name": "Cellar",
                                            "arrived_on": "2024-06-04",
                                            "left_on": null,
                                            "is_current": true,
                                            "reason": "Harvest season",
                                            "note": "Mose carried it down.",
                                            "created_at": 1773450000
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/schrute-farms/possessions/5e1b7c93-4a28-4d6f-9b02-7c3e8a1f4d60/location-stays/f1d72a8c-5e39-4b16-9c04-7a3e6b2d8f15",
                                            "web": "https://my.monicahq.com/vaults/schrute-farms/possessions/5e1b7c93-4a28-4d6f-9b02-7c3e8a1f4d60/locations"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "possession-location-stays-show-query",
                "tags": [
                    "Possession locations"
                ],
                "summary": "Get a stay",
                "description": "Retrieve one stay of a possession.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "stay",
                        "in": "path",
                        "required": true,
                        "description": "The id of the stay. A stay of another possession answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A stay object. A vault, a possession or a stay of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession location stay.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_location_stay. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "location_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The id of the location of the account where the possession stayed. Its full path comes from the locations endpoints."
                                                        },
                                                        "location_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The name of that location, without the locations around it."
                                                        },
                                                        "arrived_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day it arrived, as YYYY-MM-DD, or null when the day is unknown."
                                                        },
                                                        "left_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day it left, as YYYY-MM-DD, or null on the stay where it is now."
                                                        },
                                                        "is_current": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether it is the open stay, where the possession is now. A possession has at most one."
                                                        },
                                                        "reason": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Why it went there, or null."
                                                        },
                                                        "note": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Anything worth knowing about the stay, or null."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the stay was recorded, as a count of seconds since 1970."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The Locations section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_location_stay",
                                        "id": "f1d72a8c-5e39-4b16-9c04-7a3e6b2d8f15",
                                        "attributes": {
                                            "location_id": "6e2f8b31-7c4d-4a95-b1e8-3d9c5a7f2e60",
                                            "location_name": "Cellar",
                                            "arrived_on": "2024-06-04",
                                            "left_on": null,
                                            "is_current": true,
                                            "reason": "Harvest season",
                                            "note": "Mose carried it down.",
                                            "created_at": 1773450000
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/schrute-farms/possessions/5e1b7c93-4a28-4d6f-9b02-7c3e8a1f4d60/location-stays/f1d72a8c-5e39-4b16-9c04-7a3e6b2d8f15",
                                            "web": "https://my.monicahq.com/vaults/schrute-farms/possessions/5e1b7c93-4a28-4d6f-9b02-7c3e8a1f4d60/locations"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "put": {
                "operationId": "possession-location-stays-update",
                "tags": [
                    "Possession locations"
                ],
                "summary": "Correct a stay",
                "description": "Correct one stay of a possession.\n\nWhat you leave out keeps its value, and what you send as null is cleared. Only this stay changes: the stays before and after it are not moved. Correcting the location of the open stay changes where the possession is now. The change is written to the account log.\n\nA past stay without a day it left answers 422 on left_on (\"Enter the day it left.\"), as does a day it left before the day it arrived (\"This is before the day it arrived.\"). The open stay cannot be given a day it left (\"Move the possession to close the current stay.\").\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "stay",
                        "in": "path",
                        "required": true,
                        "description": "The id of the stay. A stay of another possession answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "location_id": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "The id of a location of the account."
                                    },
                                    "arrived_on": {
                                        "type": "string",
                                        "description": "The day it arrived, as YYYY-MM-DD, or null when unknown."
                                    },
                                    "left_on": {
                                        "type": "string",
                                        "description": "The day it left, as YYYY-MM-DD. Only for a past stay."
                                    },
                                    "reason": {
                                        "type": "string",
                                        "description": "Why it was there, up to 255 characters."
                                    },
                                    "note": {
                                        "type": "string",
                                        "description": "Anything worth knowing about the stay, up to 5,000 characters."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The stay object, as it now stands. A stay of another possession or of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession location stay.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_location_stay. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "location_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The id of the location of the account where the possession stayed. Its full path comes from the locations endpoints."
                                                        },
                                                        "location_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The name of that location, without the locations around it."
                                                        },
                                                        "arrived_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day it arrived, as YYYY-MM-DD, or null when the day is unknown."
                                                        },
                                                        "left_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day it left, as YYYY-MM-DD, or null on the stay where it is now."
                                                        },
                                                        "is_current": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether it is the open stay, where the possession is now. A possession has at most one."
                                                        },
                                                        "reason": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Why it went there, or null."
                                                        },
                                                        "note": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Anything worth knowing about the stay, or null."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the stay was recorded, as a count of seconds since 1970."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The Locations section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_location_stay",
                                        "id": "3b9e4f27-8d61-4c0a-a5f3-1e7c2d9b6a48",
                                        "attributes": {
                                            "location_id": "9c4a1e7f-2b58-4d36-8e09-5f3b7a1c6d24",
                                            "location_name": "Barn",
                                            "arrived_on": "2019-11-08",
                                            "left_on": "2024-06-04",
                                            "is_current": false,
                                            "reason": "After the harvest",
                                            "note": null,
                                            "created_at": 1773446400
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/schrute-farms/possessions/5e1b7c93-4a28-4d6f-9b02-7c3e8a1f4d60/location-stays/3b9e4f27-8d61-4c0a-a5f3-1e7c2d9b6a48",
                                            "web": "https://my.monicahq.com/vaults/schrute-farms/possessions/5e1b7c93-4a28-4d6f-9b02-7c3e8a1f4d60/locations"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "delete": {
                "operationId": "possession-location-stays-destroy",
                "tags": [
                    "Possession locations"
                ],
                "summary": "Delete a stay",
                "description": "Delete one stay of a possession.\n\nThe deletion is final. The other stays are not moved, so its period shows as unrecorded. Deleting the open stay leaves the possession with no current location until it is moved. The location itself stays. The account log keeps the name of the possession.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "stay",
                        "in": "path",
                        "required": true,
                        "description": "The id of the stay. A stay of another possession answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Nothing. A stay of another possession or of another account answers 404."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/possessions/{possession}/loans": {
            "get": {
                "operationId": "possession-loans-index",
                "tags": [
                    "Possession loans"
                ],
                "summary": "List the loans of a possession",
                "description": "List every loan of a possession, newest first.\n\nOn the same day, the latest recorded comes first. The list is whole rather than paginated.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Every loan object of the possession, or an empty list. A vault or a possession of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "Every one of the possession loans, whole rather than a page at a time.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One possession loan.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always possession_loan. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "direction": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "lent when the possession left your hands, borrowed when it came into them."
                                                            },
                                                            "status": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "planned, active or returned. A possession has at most one active loan."
                                                            },
                                                            "is_overdue": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the loan is active and its due day has passed, in the time zone of the person asking. It is worked out, never stored."
                                                            },
                                                            "contact_id": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "format": "uuid",
                                                                "description": "The id of the contact who has it or lent it, or null once that contact is deleted."
                                                            },
                                                            "contact_name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The name of that contact, or null once that contact is deleted."
                                                            },
                                                            "started_on": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The day the loan started, as YYYY-MM-DD."
                                                            },
                                                            "due_on": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The day it is due back, as YYYY-MM-DD, or null when no day was agreed."
                                                            },
                                                            "returned_on": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The day it came back, as YYYY-MM-DD, or null unless the loan is returned."
                                                            },
                                                            "condition_out_id": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "format": "uuid",
                                                                "description": "The id of the possession condition it left in, or null."
                                                            },
                                                            "condition_back_id": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "format": "uuid",
                                                                "description": "The id of the possession condition it came back in, or null."
                                                            },
                                                            "deposit_amount": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "A deposit left against the loan, as a decimal with two places, or null."
                                                            },
                                                            "deposit_currency": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The currency of the deposit, as a lowercase ISO code, or null without a deposit."
                                                            },
                                                            "purpose": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Why it was lent or borrowed, or null."
                                                            },
                                                            "is_in_provenance": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the loan records a change of custody in the provenance when it starts and another when it ends."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the loan was recorded, as a count of seconds since 1970."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The Loans section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "possession_loan",
                                            "id": "b2e9f4c7-1a63-4d58-8e07-3c5d9a1f6b28",
                                            "attributes": {
                                                "direction": "lent",
                                                "status": "active",
                                                "is_overdue": false,
                                                "contact_id": "7f1c3e58-9a24-4b6d-8c03-5e2a7d9f1b46",
                                                "contact_name": "Dwight Schrute",
                                                "started_on": "2026-11-01",
                                                "due_on": "2026-11-30",
                                                "returned_on": null,
                                                "condition_out_id": "2e6b9d14-5c87-4a30-b9f2-1d4e8a6c3f57",
                                                "condition_back_id": null,
                                                "deposit_amount": "50.00",
                                                "deposit_currency": "usd",
                                                "purpose": "The beet harvest party at Schrute Farms.",
                                                "is_in_provenance": true,
                                                "created_at": 1773450000
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/8a3d1f62-7b4e-4c95-a0e1-2f6c9b5d3e71/loans/b2e9f4c7-1a63-4d58-8e07-3c5d9a1f6b28",
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/8a3d1f62-7b4e-4c95-a0e1-2f6c9b5d3e71/loans"
                                            }
                                        },
                                        {
                                            "type": "possession_loan",
                                            "id": "4c7e2a91-3f58-4b06-9d1e-6a2f8c3b5e04",
                                            "attributes": {
                                                "direction": "lent",
                                                "status": "returned",
                                                "is_overdue": false,
                                                "contact_id": "d4a8c2f1-6e39-4b75-a0d2-8f1e3c7b5a69",
                                                "contact_name": "Pam Beesly",
                                                "started_on": "2024-06-12",
                                                "due_on": "2024-06-15",
                                                "returned_on": "2024-06-15",
                                                "condition_out_id": "2e6b9d14-5c87-4a30-b9f2-1d4e8a6c3f57",
                                                "condition_back_id": "2e6b9d14-5c87-4a30-b9f2-1d4e8a6c3f57",
                                                "deposit_amount": null,
                                                "deposit_currency": null,
                                                "purpose": "Worn at the wedding at Niagara Falls.",
                                                "is_in_provenance": false,
                                                "created_at": 1773446400
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/8a3d1f62-7b4e-4c95-a0e1-2f6c9b5d3e71/loans/4c7e2a91-3f58-4b06-9d1e-6a2f8c3b5e04",
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/8a3d1f62-7b4e-4c95-a0e1-2f6c9b5d3e71/loans"
                                            }
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "possession-loans-index-query",
                "tags": [
                    "Possession loans"
                ],
                "summary": "List the loans of a possession",
                "description": "List every loan of a possession, newest first.\n\nOn the same day, the latest recorded comes first. The list is whole rather than paginated.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Every loan object of the possession, or an empty list. A vault or a possession of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "Every one of the possession loans, whole rather than a page at a time.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One possession loan.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always possession_loan. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "direction": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "lent when the possession left your hands, borrowed when it came into them."
                                                            },
                                                            "status": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "planned, active or returned. A possession has at most one active loan."
                                                            },
                                                            "is_overdue": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the loan is active and its due day has passed, in the time zone of the person asking. It is worked out, never stored."
                                                            },
                                                            "contact_id": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "format": "uuid",
                                                                "description": "The id of the contact who has it or lent it, or null once that contact is deleted."
                                                            },
                                                            "contact_name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The name of that contact, or null once that contact is deleted."
                                                            },
                                                            "started_on": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The day the loan started, as YYYY-MM-DD."
                                                            },
                                                            "due_on": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The day it is due back, as YYYY-MM-DD, or null when no day was agreed."
                                                            },
                                                            "returned_on": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The day it came back, as YYYY-MM-DD, or null unless the loan is returned."
                                                            },
                                                            "condition_out_id": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "format": "uuid",
                                                                "description": "The id of the possession condition it left in, or null."
                                                            },
                                                            "condition_back_id": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "format": "uuid",
                                                                "description": "The id of the possession condition it came back in, or null."
                                                            },
                                                            "deposit_amount": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "A deposit left against the loan, as a decimal with two places, or null."
                                                            },
                                                            "deposit_currency": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The currency of the deposit, as a lowercase ISO code, or null without a deposit."
                                                            },
                                                            "purpose": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Why it was lent or borrowed, or null."
                                                            },
                                                            "is_in_provenance": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether the loan records a change of custody in the provenance when it starts and another when it ends."
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the loan was recorded, as a count of seconds since 1970."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The Loans section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "possession_loan",
                                            "id": "b2e9f4c7-1a63-4d58-8e07-3c5d9a1f6b28",
                                            "attributes": {
                                                "direction": "lent",
                                                "status": "active",
                                                "is_overdue": false,
                                                "contact_id": "7f1c3e58-9a24-4b6d-8c03-5e2a7d9f1b46",
                                                "contact_name": "Dwight Schrute",
                                                "started_on": "2026-11-01",
                                                "due_on": "2026-11-30",
                                                "returned_on": null,
                                                "condition_out_id": "2e6b9d14-5c87-4a30-b9f2-1d4e8a6c3f57",
                                                "condition_back_id": null,
                                                "deposit_amount": "50.00",
                                                "deposit_currency": "usd",
                                                "purpose": "The beet harvest party at Schrute Farms.",
                                                "is_in_provenance": true,
                                                "created_at": 1773450000
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/8a3d1f62-7b4e-4c95-a0e1-2f6c9b5d3e71/loans/b2e9f4c7-1a63-4d58-8e07-3c5d9a1f6b28",
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/8a3d1f62-7b4e-4c95-a0e1-2f6c9b5d3e71/loans"
                                            }
                                        },
                                        {
                                            "type": "possession_loan",
                                            "id": "4c7e2a91-3f58-4b06-9d1e-6a2f8c3b5e04",
                                            "attributes": {
                                                "direction": "lent",
                                                "status": "returned",
                                                "is_overdue": false,
                                                "contact_id": "d4a8c2f1-6e39-4b75-a0d2-8f1e3c7b5a69",
                                                "contact_name": "Pam Beesly",
                                                "started_on": "2024-06-12",
                                                "due_on": "2024-06-15",
                                                "returned_on": "2024-06-15",
                                                "condition_out_id": "2e6b9d14-5c87-4a30-b9f2-1d4e8a6c3f57",
                                                "condition_back_id": "2e6b9d14-5c87-4a30-b9f2-1d4e8a6c3f57",
                                                "deposit_amount": null,
                                                "deposit_currency": null,
                                                "purpose": "Worn at the wedding at Niagara Falls.",
                                                "is_in_provenance": false,
                                                "created_at": 1773446400
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/8a3d1f62-7b4e-4c95-a0e1-2f6c9b5d3e71/loans/4c7e2a91-3f58-4b06-9d1e-6a2f8c3b5e04",
                                                "web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/8a3d1f62-7b4e-4c95-a0e1-2f6c9b5d3e71/loans"
                                            }
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "post": {
                "operationId": "possession-loans-create",
                "tags": [
                    "Possession loans"
                ],
                "summary": "Record a loan",
                "description": "Record a possession lent to a contact of its vault, or borrowed from one.\n\nName an existing contact with contact_id, or write a new one down with new_contact: the contact and the loan are then saved together, or neither is. A contact of another vault answers 404. The change is written to the account log.\n\nA planned or active loan of a possession that is sold, given away, thrown away, lost or stolen answers 422 on status (\"This possession is no longer in your hands, so only a returned loan can be recorded for it.\"). A second active loan answers 422 on status (\"Another loan of this possession is active. Mark it as returned first.\"). A due day before the start answers 422 on due_on, and a returned loan without its return day answers 422 on returned_on (\"Say when it came back.\").\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "direction": {
                                        "type": "string",
                                        "description": "lent or borrowed."
                                    },
                                    "status": {
                                        "type": "string",
                                        "description": "planned, active or returned."
                                    },
                                    "contact_id": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "The id of a contact of the vault. Required without new_contact."
                                    },
                                    "new_contact": {
                                        "type": "object",
                                        "description": "A contact to write down with the loan, as first_name (required) and last_name. Required without contact_id, and refused with it."
                                    },
                                    "started_on": {
                                        "type": "string",
                                        "description": "The day the loan started, as YYYY-MM-DD."
                                    },
                                    "due_on": {
                                        "type": "string",
                                        "description": "The day it is due back, as YYYY-MM-DD. Not before started_on."
                                    },
                                    "returned_on": {
                                        "type": "string",
                                        "description": "The day it came back, as YYYY-MM-DD. Required for a returned loan, not before started_on, and ignored otherwise."
                                    },
                                    "condition_out_id": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "The id of a possession condition of the account, the one it left in."
                                    },
                                    "condition_back_id": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "The id of a possession condition of the account, the one it came back in. Kept only for a returned loan."
                                    },
                                    "deposit_amount": {
                                        "type": "string",
                                        "description": "A deposit left against the loan, from 0 to 9,999,999,999.99."
                                    },
                                    "deposit_currency": {
                                        "type": "string",
                                        "description": "The currency of the deposit, as a lowercase ISO code. Required with a deposit."
                                    },
                                    "purpose": {
                                        "type": "string",
                                        "description": "Why it was lent or borrowed, up to 5,000 characters. Markup is stripped."
                                    },
                                    "is_in_provenance": {
                                        "type": "boolean",
                                        "description": "Whether the loan records a change of custody in the provenance when it starts and another when it ends. False when left out."
                                    }
                                },
                                "required": [
                                    "direction",
                                    "status",
                                    "started_on"
                                ]
                            },
                            "example": {
                                "direction": "lent",
                                "status": "active",
                                "contact_id": "7f1c3e58-9a24-4b6d-8c03-5e2a7d9f1b46",
                                "started_on": "2026-11-01"
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The new loan object.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession loan.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_loan. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "direction": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "lent when the possession left your hands, borrowed when it came into them."
                                                        },
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "planned, active or returned. A possession has at most one active loan."
                                                        },
                                                        "is_overdue": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the loan is active and its due day has passed, in the time zone of the person asking. It is worked out, never stored."
                                                        },
                                                        "contact_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The id of the contact who has it or lent it, or null once that contact is deleted."
                                                        },
                                                        "contact_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The name of that contact, or null once that contact is deleted."
                                                        },
                                                        "started_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day the loan started, as YYYY-MM-DD."
                                                        },
                                                        "due_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day it is due back, as YYYY-MM-DD, or null when no day was agreed."
                                                        },
                                                        "returned_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day it came back, as YYYY-MM-DD, or null unless the loan is returned."
                                                        },
                                                        "condition_out_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The id of the possession condition it left in, or null."
                                                        },
                                                        "condition_back_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The id of the possession condition it came back in, or null."
                                                        },
                                                        "deposit_amount": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "A deposit left against the loan, as a decimal with two places, or null."
                                                        },
                                                        "deposit_currency": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The currency of the deposit, as a lowercase ISO code, or null without a deposit."
                                                        },
                                                        "purpose": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Why it was lent or borrowed, or null."
                                                        },
                                                        "is_in_provenance": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the loan records a change of custody in the provenance when it starts and another when it ends."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the loan was recorded, as a count of seconds since 1970."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The Loans section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_loan",
                                        "id": "b2e9f4c7-1a63-4d58-8e07-3c5d9a1f6b28",
                                        "attributes": {
                                            "direction": "lent",
                                            "status": "active",
                                            "is_overdue": false,
                                            "contact_id": "7f1c3e58-9a24-4b6d-8c03-5e2a7d9f1b46",
                                            "contact_name": "Dwight Schrute",
                                            "started_on": "2026-11-01",
                                            "due_on": "2026-11-30",
                                            "returned_on": null,
                                            "condition_out_id": "2e6b9d14-5c87-4a30-b9f2-1d4e8a6c3f57",
                                            "condition_back_id": null,
                                            "deposit_amount": "50.00",
                                            "deposit_currency": "usd",
                                            "purpose": "The beet harvest party at Schrute Farms.",
                                            "is_in_provenance": true,
                                            "created_at": 1773450000
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/8a3d1f62-7b4e-4c95-a0e1-2f6c9b5d3e71/loans/b2e9f4c7-1a63-4d58-8e07-3c5d9a1f6b28",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/8a3d1f62-7b4e-4c95-a0e1-2f6c9b5d3e71/loans"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/possessions/{possession}/loans/{loan}": {
            "get": {
                "operationId": "possession-loans-show",
                "tags": [
                    "Possession loans"
                ],
                "summary": "Get a loan",
                "description": "Retrieve one loan of a possession.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "loan",
                        "in": "path",
                        "required": true,
                        "description": "The id of the loan. A loan of another possession answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A loan object. A vault, a possession or a loan of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession loan.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_loan. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "direction": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "lent when the possession left your hands, borrowed when it came into them."
                                                        },
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "planned, active or returned. A possession has at most one active loan."
                                                        },
                                                        "is_overdue": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the loan is active and its due day has passed, in the time zone of the person asking. It is worked out, never stored."
                                                        },
                                                        "contact_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The id of the contact who has it or lent it, or null once that contact is deleted."
                                                        },
                                                        "contact_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The name of that contact, or null once that contact is deleted."
                                                        },
                                                        "started_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day the loan started, as YYYY-MM-DD."
                                                        },
                                                        "due_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day it is due back, as YYYY-MM-DD, or null when no day was agreed."
                                                        },
                                                        "returned_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day it came back, as YYYY-MM-DD, or null unless the loan is returned."
                                                        },
                                                        "condition_out_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The id of the possession condition it left in, or null."
                                                        },
                                                        "condition_back_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The id of the possession condition it came back in, or null."
                                                        },
                                                        "deposit_amount": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "A deposit left against the loan, as a decimal with two places, or null."
                                                        },
                                                        "deposit_currency": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The currency of the deposit, as a lowercase ISO code, or null without a deposit."
                                                        },
                                                        "purpose": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Why it was lent or borrowed, or null."
                                                        },
                                                        "is_in_provenance": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the loan records a change of custody in the provenance when it starts and another when it ends."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the loan was recorded, as a count of seconds since 1970."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The Loans section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_loan",
                                        "id": "b2e9f4c7-1a63-4d58-8e07-3c5d9a1f6b28",
                                        "attributes": {
                                            "direction": "lent",
                                            "status": "active",
                                            "is_overdue": false,
                                            "contact_id": "7f1c3e58-9a24-4b6d-8c03-5e2a7d9f1b46",
                                            "contact_name": "Dwight Schrute",
                                            "started_on": "2026-11-01",
                                            "due_on": "2026-11-30",
                                            "returned_on": null,
                                            "condition_out_id": "2e6b9d14-5c87-4a30-b9f2-1d4e8a6c3f57",
                                            "condition_back_id": null,
                                            "deposit_amount": "50.00",
                                            "deposit_currency": "usd",
                                            "purpose": "The beet harvest party at Schrute Farms.",
                                            "is_in_provenance": true,
                                            "created_at": 1773450000
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/8a3d1f62-7b4e-4c95-a0e1-2f6c9b5d3e71/loans/b2e9f4c7-1a63-4d58-8e07-3c5d9a1f6b28",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/8a3d1f62-7b4e-4c95-a0e1-2f6c9b5d3e71/loans"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "possession-loans-show-query",
                "tags": [
                    "Possession loans"
                ],
                "summary": "Get a loan",
                "description": "Retrieve one loan of a possession.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "loan",
                        "in": "path",
                        "required": true,
                        "description": "The id of the loan. A loan of another possession answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A loan object. A vault, a possession or a loan of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession loan.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_loan. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "direction": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "lent when the possession left your hands, borrowed when it came into them."
                                                        },
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "planned, active or returned. A possession has at most one active loan."
                                                        },
                                                        "is_overdue": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the loan is active and its due day has passed, in the time zone of the person asking. It is worked out, never stored."
                                                        },
                                                        "contact_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The id of the contact who has it or lent it, or null once that contact is deleted."
                                                        },
                                                        "contact_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The name of that contact, or null once that contact is deleted."
                                                        },
                                                        "started_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day the loan started, as YYYY-MM-DD."
                                                        },
                                                        "due_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day it is due back, as YYYY-MM-DD, or null when no day was agreed."
                                                        },
                                                        "returned_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day it came back, as YYYY-MM-DD, or null unless the loan is returned."
                                                        },
                                                        "condition_out_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The id of the possession condition it left in, or null."
                                                        },
                                                        "condition_back_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The id of the possession condition it came back in, or null."
                                                        },
                                                        "deposit_amount": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "A deposit left against the loan, as a decimal with two places, or null."
                                                        },
                                                        "deposit_currency": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The currency of the deposit, as a lowercase ISO code, or null without a deposit."
                                                        },
                                                        "purpose": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Why it was lent or borrowed, or null."
                                                        },
                                                        "is_in_provenance": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the loan records a change of custody in the provenance when it starts and another when it ends."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the loan was recorded, as a count of seconds since 1970."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The Loans section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_loan",
                                        "id": "b2e9f4c7-1a63-4d58-8e07-3c5d9a1f6b28",
                                        "attributes": {
                                            "direction": "lent",
                                            "status": "active",
                                            "is_overdue": false,
                                            "contact_id": "7f1c3e58-9a24-4b6d-8c03-5e2a7d9f1b46",
                                            "contact_name": "Dwight Schrute",
                                            "started_on": "2026-11-01",
                                            "due_on": "2026-11-30",
                                            "returned_on": null,
                                            "condition_out_id": "2e6b9d14-5c87-4a30-b9f2-1d4e8a6c3f57",
                                            "condition_back_id": null,
                                            "deposit_amount": "50.00",
                                            "deposit_currency": "usd",
                                            "purpose": "The beet harvest party at Schrute Farms.",
                                            "is_in_provenance": true,
                                            "created_at": 1773450000
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/8a3d1f62-7b4e-4c95-a0e1-2f6c9b5d3e71/loans/b2e9f4c7-1a63-4d58-8e07-3c5d9a1f6b28",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/8a3d1f62-7b4e-4c95-a0e1-2f6c9b5d3e71/loans"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "put": {
                "operationId": "possession-loans-update",
                "tags": [
                    "Possession loans"
                ],
                "summary": "Change a loan",
                "description": "Change one loan of a possession, including marking it as returned.\n\nWhat you leave out keeps its value, and what you send as null is cleared. A loan that is not returned loses its return day and the condition it came back in, and its provenance events follow what it now says. The change is written to the account log.\n\nThe same refusals apply as when recording a loan.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "loan",
                        "in": "path",
                        "required": true,
                        "description": "The id of the loan. A loan of another possession answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "direction": {
                                        "type": "string",
                                        "description": "lent or borrowed."
                                    },
                                    "status": {
                                        "type": "string",
                                        "description": "planned, active or returned."
                                    },
                                    "contact_id": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "The id of a contact of the vault."
                                    },
                                    "started_on": {
                                        "type": "string",
                                        "description": "The day the loan started, as YYYY-MM-DD."
                                    },
                                    "due_on": {
                                        "type": "string",
                                        "description": "The day it is due back, as YYYY-MM-DD. Not before started_on."
                                    },
                                    "returned_on": {
                                        "type": "string",
                                        "description": "The day it came back, as YYYY-MM-DD. Required for a returned loan, not before started_on, and ignored otherwise."
                                    },
                                    "condition_out_id": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "The id of a possession condition of the account, the one it left in."
                                    },
                                    "condition_back_id": {
                                        "type": "string",
                                        "format": "uuid",
                                        "description": "The id of a possession condition of the account, the one it came back in. Kept only for a returned loan."
                                    },
                                    "deposit_amount": {
                                        "type": "string",
                                        "description": "A deposit left against the loan, from 0 to 9,999,999,999.99."
                                    },
                                    "deposit_currency": {
                                        "type": "string",
                                        "description": "The currency of the deposit, as a lowercase ISO code. Required with a deposit."
                                    },
                                    "purpose": {
                                        "type": "string",
                                        "description": "Why it was lent or borrowed, up to 5,000 characters. Markup is stripped."
                                    },
                                    "is_in_provenance": {
                                        "type": "boolean",
                                        "description": "Whether the loan records a change of custody in the provenance when it starts and another when it ends. False when left out."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The loan object, as it now stands. A loan of another possession or of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The possession loan.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always possession_loan. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "direction": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "lent when the possession left your hands, borrowed when it came into them."
                                                        },
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "planned, active or returned. A possession has at most one active loan."
                                                        },
                                                        "is_overdue": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the loan is active and its due day has passed, in the time zone of the person asking. It is worked out, never stored."
                                                        },
                                                        "contact_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The id of the contact who has it or lent it, or null once that contact is deleted."
                                                        },
                                                        "contact_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The name of that contact, or null once that contact is deleted."
                                                        },
                                                        "started_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day the loan started, as YYYY-MM-DD."
                                                        },
                                                        "due_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day it is due back, as YYYY-MM-DD, or null when no day was agreed."
                                                        },
                                                        "returned_on": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The day it came back, as YYYY-MM-DD, or null unless the loan is returned."
                                                        },
                                                        "condition_out_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The id of the possession condition it left in, or null."
                                                        },
                                                        "condition_back_id": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "format": "uuid",
                                                            "description": "The id of the possession condition it came back in, or null."
                                                        },
                                                        "deposit_amount": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "A deposit left against the loan, as a decimal with two places, or null."
                                                        },
                                                        "deposit_currency": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The currency of the deposit, as a lowercase ISO code, or null without a deposit."
                                                        },
                                                        "purpose": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Why it was lent or borrowed, or null."
                                                        },
                                                        "is_in_provenance": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether the loan records a change of custody in the provenance when it starts and another when it ends."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the loan was recorded, as a count of seconds since 1970."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        },
                                                        "web": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The Loans section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "possession_loan",
                                        "id": "4c7e2a91-3f58-4b06-9d1e-6a2f8c3b5e04",
                                        "attributes": {
                                            "direction": "lent",
                                            "status": "returned",
                                            "is_overdue": false,
                                            "contact_id": "d4a8c2f1-6e39-4b75-a0d2-8f1e3c7b5a69",
                                            "contact_name": "Pam Beesly",
                                            "started_on": "2024-06-12",
                                            "due_on": "2024-06-15",
                                            "returned_on": "2024-06-15",
                                            "condition_out_id": "2e6b9d14-5c87-4a30-b9f2-1d4e8a6c3f57",
                                            "condition_back_id": "2e6b9d14-5c87-4a30-b9f2-1d4e8a6c3f57",
                                            "deposit_amount": null,
                                            "deposit_currency": null,
                                            "purpose": "Worn at the wedding at Niagara Falls.",
                                            "is_in_provenance": false,
                                            "created_at": 1773446400
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/8a3d1f62-7b4e-4c95-a0e1-2f6c9b5d3e71/loans/4c7e2a91-3f58-4b06-9d1e-6a2f8c3b5e04",
                                            "web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/8a3d1f62-7b4e-4c95-a0e1-2f6c9b5d3e71/loans"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "delete": {
                "operationId": "possession-loans-destroy",
                "tags": [
                    "Possession loans"
                ],
                "summary": "Delete a loan",
                "description": "Delete one loan of a possession.\n\nThe deletion is final, and the provenance events the loan wrote are deleted with it. The contact stays. The account log keeps the name of the possession.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "loan",
                        "in": "path",
                        "required": true,
                        "description": "The id of the loan. A loan of another possession answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Nothing. A loan of another possession or of another account answers 404."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/vaults/{vault}/possessions/{possession}/timeline": {
            "get": {
                "operationId": "possession-timeline-index",
                "tags": [
                    "Possession timeline"
                ],
                "summary": "List the timeline of a possession",
                "description": "List everything that happened to a possession, the newest first.\n\nAn entry comes from each transaction, insurance record, valuation, provenance event, maintenance record and stay, and from each loan once it started and again once it came back. A planned loan gives none. A provenance event that a loan or a transaction wrote gives none, since the loan or the transaction already gives that moment.\n\nOn the same day, the latest recorded comes first. Entries without a date come last.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    },
                    {
                        "name": "section",
                        "in": "query",
                        "required": false,
                        "description": "Only the entries of this section: transactions, insurance, valuations, provenance, maintenance, loans or locations. Anything else answers 422.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Every entry of the timeline, or an empty list. A vault or a possession of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "Every entry of the timeline, whole rather than a page at a time, the newest first and the undated last.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One entry.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always possession_timeline_entry. An entry is computed, so it has no id of its own."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "What the entry says.",
                                                        "properties": {
                                                            "section": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The section it is read from: transactions, insurance, valuations, provenance, maintenance, loans or locations."
                                                            },
                                                            "kind": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What happened: transaction, insurance, valuation, provenance, maintenance, loan_started, loan_returned or stay. A loan that came back gives two entries, one of each loan kind."
                                                            },
                                                            "date": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "When it happened, written as 2026-11-02, or null when nobody knows."
                                                            },
                                                            "date_precision": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "How precise the date is: day, month, year, circa or unknown. Only a provenance event is ever less precise than a day."
                                                            },
                                                            "is_current": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether this is the valuation giving the current value, or the stay where the possession is now."
                                                            },
                                                            "is_acquisition": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether this transaction brought the possession in: a purchase, an exchange, a gift received or an inheritance."
                                                            },
                                                            "record_id": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "format": "uuid",
                                                                "description": "The id of the record the entry is read from."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find the record.",
                                                        "properties": {
                                                            "record": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address the record is read from, in its own section."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "possession_timeline_entry",
                                            "attributes": {
                                                "section": "loans",
                                                "kind": "loan_returned",
                                                "date": "2026-11-02",
                                                "date_precision": "day",
                                                "is_current": false,
                                                "is_acquisition": false,
                                                "record_id": "8a3f1c60-2b47-4e9d-b1a5-7c0e9d3f2b48"
                                            },
                                            "links": {
                                                "record": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/5e2c8a14-7d39-4b61-a0f3-c9e18b2d4f70/loans/8a3f1c60-2b47-4e9d-b1a5-7c0e9d3f2b48"
                                            }
                                        },
                                        {
                                            "type": "possession_timeline_entry",
                                            "attributes": {
                                                "section": "maintenance",
                                                "kind": "maintenance",
                                                "date": "2026-09-14",
                                                "date_precision": "day",
                                                "is_current": false,
                                                "is_acquisition": false,
                                                "record_id": "2c9d4e71-6a15-4f38-9b02-e7f1a3c5d846"
                                            },
                                            "links": {
                                                "record": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/5e2c8a14-7d39-4b61-a0f3-c9e18b2d4f70/maintenance-records/2c9d4e71-6a15-4f38-9b02-e7f1a3c5d846"
                                            }
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "possession-timeline-index-query",
                "tags": [
                    "Possession timeline"
                ],
                "summary": "List the timeline of a possession",
                "description": "List everything that happened to a possession, the newest first.\n\nAn entry comes from each transaction, insurance record, valuation, provenance event, maintenance record and stay, and from each loan once it started and again once it came back. A planned loan gives none. A provenance event that a loan or a transaction wrote gives none, since the loan or the transaction already gives that moment.\n\nOn the same day, the latest recorded comes first. Entries without a date come last.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "vault",
                        "in": "path",
                        "required": true,
                        "description": "The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "possession",
                        "in": "path",
                        "required": true,
                        "description": "The id of the possession. A possession of another vault or of another account answers 404.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "section": {
                                        "type": "string",
                                        "description": "Only the entries of this section: transactions, insurance, valuations, provenance, maintenance, loans or locations. Anything else answers 422."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Every entry of the timeline, or an empty list. A vault or a possession of another account answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "Every entry of the timeline, whole rather than a page at a time, the newest first and the undated last.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One entry.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always possession_timeline_entry. An entry is computed, so it has no id of its own."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "What the entry says.",
                                                        "properties": {
                                                            "section": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The section it is read from: transactions, insurance, valuations, provenance, maintenance, loans or locations."
                                                            },
                                                            "kind": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What happened: transaction, insurance, valuation, provenance, maintenance, loan_started, loan_returned or stay. A loan that came back gives two entries, one of each loan kind."
                                                            },
                                                            "date": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "When it happened, written as 2026-11-02, or null when nobody knows."
                                                            },
                                                            "date_precision": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "How precise the date is: day, month, year, circa or unknown. Only a provenance event is ever less precise than a day."
                                                            },
                                                            "is_current": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether this is the valuation giving the current value, or the stay where the possession is now."
                                                            },
                                                            "is_acquisition": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether this transaction brought the possession in: a purchase, an exchange, a gift received or an inheritance."
                                                            },
                                                            "record_id": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "format": "uuid",
                                                                "description": "The id of the record the entry is read from."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find the record.",
                                                        "properties": {
                                                            "record": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address the record is read from, in its own section."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "possession_timeline_entry",
                                            "attributes": {
                                                "section": "loans",
                                                "kind": "loan_returned",
                                                "date": "2026-11-02",
                                                "date_precision": "day",
                                                "is_current": false,
                                                "is_acquisition": false,
                                                "record_id": "8a3f1c60-2b47-4e9d-b1a5-7c0e9d3f2b48"
                                            },
                                            "links": {
                                                "record": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/5e2c8a14-7d39-4b61-a0f3-c9e18b2d4f70/loans/8a3f1c60-2b47-4e9d-b1a5-7c0e9d3f2b48"
                                            }
                                        },
                                        {
                                            "type": "possession_timeline_entry",
                                            "attributes": {
                                                "section": "maintenance",
                                                "kind": "maintenance",
                                                "date": "2026-09-14",
                                                "date_precision": "day",
                                                "is_current": false,
                                                "is_acquisition": false,
                                                "record_id": "2c9d4e71-6a15-4f38-9b02-e7f1a3c5d846"
                                            },
                                            "links": {
                                                "record": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/5e2c8a14-7d39-4b61-a0f3-c9e18b2d4f70/maintenance-records/2c9d4e71-6a15-4f38-9b02-e7f1a3c5d846"
                                            }
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/changelog-entries": {
            "get": {
                "operationId": "changelog-entries-index",
                "tags": [
                    "What’s new"
                ],
                "summary": "List what’s new",
                "description": "List the changes published over the last 30 or 90 days, newest day first.\n\nWithin a day, features and improvements come before fixes, each newest first. A change scheduled for later is left out until it is published. Reading the list does not mark anything as seen.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "period",
                        "in": "query",
                        "required": false,
                        "description": "How many days back to reach: 30 or 90. Any other value reads as 30.",
                        "schema": {
                            "type": "integer",
                            "default": 30
                        }
                    },
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to answer with.",
                        "schema": {
                            "type": "integer",
                            "default": 1
                        }
                    },
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "How many records one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused.",
                        "schema": {
                            "type": "integer",
                            "default": 25
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of change objects, how many there are in all, and in meta what the period holds.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The changes on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One change.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always changelog_entry. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "entry_type": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "feature, improvement or fix."
                                                            },
                                                            "area": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The part of the product the change touches, in your language, or null."
                                                            },
                                                            "title": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What changed, in one line, in your language."
                                                            },
                                                            "body": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The explanation, as Markdown, in your language."
                                                            },
                                                            "body_html": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The same explanation, turned into HTML."
                                                            },
                                                            "link": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address of the screen the change concerns, or null."
                                                            },
                                                            "day": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The day the change was published, as YYYY-MM-DD, in UTC."
                                                            },
                                                            "is_seen": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether you have seen it. A change published before you joined counts as seen."
                                                            },
                                                            "my_vote": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "up or down when you voted on the change, or null."
                                                            },
                                                            "comment_count": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How many comments everybody can read under the change. Private comments and comments hidden by an administrator are not counted."
                                                            },
                                                            "published_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the change was published, as a count of seconds since 1970."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find more about this change.",
                                                        "properties": {
                                                            "comments": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address the comments of the change are read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The What’s new screen in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "changelog_entry",
                                            "id": "01M7NBFWK5XNH908RFDGEAJXKN",
                                            "attributes": {
                                                "entry_type": "feature",
                                                "area": "Contacts",
                                                "title": "Book the conference room from a contact",
                                                "body": "Michael can now book the conference room **straight** from a contact page.",
                                                "body_html": "<p>Michael can now book the conference room <strong>straight</strong> from a contact page.</p>",
                                                "link": "https://my.monicahq.com/vaults",
                                                "day": "2026-11-16",
                                                "is_seen": false,
                                                "my_vote": "up",
                                                "comment_count": 2,
                                                "published_at": 1794819600
                                            },
                                            "links": {
                                                "comments": "https://my.monicahq.com/api/v1/changelog-entries/01M7NBFWK5XNH908RFDGEAJXKN/comments",
                                                "web": "https://my.monicahq.com/changelog"
                                            }
                                        },
                                        {
                                            "type": "changelog_entry",
                                            "id": "01M7NBFWK7BEESY8WABBMXF3E6",
                                            "attributes": {
                                                "entry_type": "fix",
                                                "area": "Contacts",
                                                "title": "The fax machine no longer eats long notes",
                                                "body": "A note longer than 10,000 characters lost its last paragraph.",
                                                "body_html": "<p>A note longer than 10,000 characters lost its last paragraph.</p>",
                                                "link": null,
                                                "day": "2026-11-16",
                                                "is_seen": true,
                                                "my_vote": null,
                                                "comment_count": 0,
                                                "published_at": 1794816000
                                            },
                                            "links": {
                                                "comments": "https://my.monicahq.com/api/v1/changelog-entries/01M7NBFWK7BEESY8WABBMXF3E6/comments",
                                                "web": "https://my.monicahq.com/changelog"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 2,
                                        "period": 30,
                                        "unseen_count": 1,
                                        "days": 1,
                                        "features": 1,
                                        "improvements": 0,
                                        "fixes": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "changelog-entries-index-query",
                "tags": [
                    "What’s new"
                ],
                "summary": "List what’s new",
                "description": "List the changes published over the last 30 or 90 days, newest day first.\n\nWithin a day, features and improvements come before fixes, each newest first. A change scheduled for later is left out until it is published. Reading the list does not mark anything as seen.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "period": {
                                        "type": "integer",
                                        "default": 30,
                                        "description": "How many days back to reach: 30 or 90. Any other value reads as 30."
                                    },
                                    "page": {
                                        "type": "integer",
                                        "default": 1,
                                        "description": "Which page to answer with."
                                    },
                                    "per_page": {
                                        "type": "integer",
                                        "default": 25,
                                        "description": "How many records one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "A page of change objects, how many there are in all, and in meta what the period holds.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The changes on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One change.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always changelog_entry. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "entry_type": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "feature, improvement or fix."
                                                            },
                                                            "area": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The part of the product the change touches, in your language, or null."
                                                            },
                                                            "title": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What changed, in one line, in your language."
                                                            },
                                                            "body": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The explanation, as Markdown, in your language."
                                                            },
                                                            "body_html": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The same explanation, turned into HTML."
                                                            },
                                                            "link": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address of the screen the change concerns, or null."
                                                            },
                                                            "day": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The day the change was published, as YYYY-MM-DD, in UTC."
                                                            },
                                                            "is_seen": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether you have seen it. A change published before you joined counts as seen."
                                                            },
                                                            "my_vote": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "up or down when you voted on the change, or null."
                                                            },
                                                            "comment_count": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "How many comments everybody can read under the change. Private comments and comments hidden by an administrator are not counted."
                                                            },
                                                            "published_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the change was published, as a count of seconds since 1970."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find more about this change.",
                                                        "properties": {
                                                            "comments": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address the comments of the change are read from."
                                                            },
                                                            "web": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The What’s new screen in the application, which opens for somebody signed in rather than for a key. It is the link to give a person."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "changelog_entry",
                                            "id": "01M7NBFWK5XNH908RFDGEAJXKN",
                                            "attributes": {
                                                "entry_type": "feature",
                                                "area": "Contacts",
                                                "title": "Book the conference room from a contact",
                                                "body": "Michael can now book the conference room **straight** from a contact page.",
                                                "body_html": "<p>Michael can now book the conference room <strong>straight</strong> from a contact page.</p>",
                                                "link": "https://my.monicahq.com/vaults",
                                                "day": "2026-11-16",
                                                "is_seen": false,
                                                "my_vote": "up",
                                                "comment_count": 2,
                                                "published_at": 1794819600
                                            },
                                            "links": {
                                                "comments": "https://my.monicahq.com/api/v1/changelog-entries/01M7NBFWK5XNH908RFDGEAJXKN/comments",
                                                "web": "https://my.monicahq.com/changelog"
                                            }
                                        },
                                        {
                                            "type": "changelog_entry",
                                            "id": "01M7NBFWK7BEESY8WABBMXF3E6",
                                            "attributes": {
                                                "entry_type": "fix",
                                                "area": "Contacts",
                                                "title": "The fax machine no longer eats long notes",
                                                "body": "A note longer than 10,000 characters lost its last paragraph.",
                                                "body_html": "<p>A note longer than 10,000 characters lost its last paragraph.</p>",
                                                "link": null,
                                                "day": "2026-11-16",
                                                "is_seen": true,
                                                "my_vote": null,
                                                "comment_count": 0,
                                                "published_at": 1794816000
                                            },
                                            "links": {
                                                "comments": "https://my.monicahq.com/api/v1/changelog-entries/01M7NBFWK7BEESY8WABBMXF3E6/comments",
                                                "web": "https://my.monicahq.com/changelog"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 25,
                                        "total": 2,
                                        "period": 30,
                                        "unseen_count": 1,
                                        "days": 1,
                                        "features": 1,
                                        "improvements": 0,
                                        "fixes": 1
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/changelog-entries/seen": {
            "put": {
                "operationId": "changelog-entries-seen",
                "tags": [
                    "What’s new"
                ],
                "summary": "Mark every change as seen",
                "description": "Mark every published change as seen by you, so unseen_count comes back to zero.\n\nChanges you have already seen stay as they are, so calling it twice is harmless. A change published later is unseen again until you call it once more.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "responses": {
                    "204": {
                        "description": "Nothing."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/changelog-entries/{entry}/vote": {
            "put": {
                "operationId": "changelog-entries-vote-update",
                "tags": [
                    "What’s new"
                ],
                "summary": "Vote on a change",
                "description": "Say whether you like a change.\n\nYou hold one vote per change, so voting the other way replaces the first vote. The id of the vote is the identifier of the change. A direction other than up or down answers 422 on direction.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "entry",
                        "in": "path",
                        "required": true,
                        "description": "The identifier of the change, the 26 characters it reports as id. A change that does not exist or is not published yet answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "direction": {
                                        "type": "string",
                                        "description": "up or down."
                                    }
                                },
                                "required": [
                                    "direction"
                                ]
                            },
                            "example": {
                                "direction": "up"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The vote object. A change that does not exist answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The vote.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always changelog_vote. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "direction": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "up or down."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the vote was last cast, as a count of seconds since 1970."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "changelog_vote",
                                        "id": "01M7NBFWK5XNH908RFDGEAJXKN",
                                        "attributes": {
                                            "direction": "up",
                                            "updated_at": 1794823200
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "delete": {
                "operationId": "changelog-entries-vote-destroy",
                "tags": [
                    "What’s new"
                ],
                "summary": "Take back a vote",
                "description": "Take back your vote on a change.\n\nTaking back a vote you never cast is harmless.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "entry",
                        "in": "path",
                        "required": true,
                        "description": "The identifier of the change, the 26 characters it reports as id. A change that does not exist or is not published yet answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Nothing. A change that does not exist answers 404."
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/changelog-entries/{entry}/comments": {
            "get": {
                "operationId": "changelog-entries-comments-index",
                "tags": [
                    "What’s new"
                ],
                "summary": "List the comments of a change",
                "description": "List the comments you can read under a change, oldest first.\n\nYou read the public comments, except those an administrator hid, and every comment of your own, private or hidden. The list is whole rather than paginated.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "entry",
                        "in": "path",
                        "required": true,
                        "description": "The identifier of the change, the 26 characters it reports as id. A change that does not exist or is not published yet answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Every comment object you can read, or an empty list. A change that does not exist answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "Every comment you can read under the change, whole rather than a page at a time.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One comment.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always changelog_comment. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The identifier of this comment."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the comment holds.",
                                                        "properties": {
                                                            "author_name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The name of the person who wrote it, or Anonymous, in your language, when they chose not to show it. An anonymous comment shows Anonymous to everybody, its author included."
                                                            },
                                                            "is_mine": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether you wrote it."
                                                            },
                                                            "is_private": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether only the administrators of the instance read it. Only its author sees a private comment in this list."
                                                            },
                                                            "is_anonymous": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether it is shown without the name of its author. A private comment is never anonymous."
                                                            },
                                                            "body": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The comment, as plain text."
                                                            },
                                                            "replies": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "The public answers of the administrators, oldest first, or an empty list.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One answer.",
                                                                    "properties": {
                                                                        "author_name": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The name the administrator answered under."
                                                                        },
                                                                        "body": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The answer, as plain text."
                                                                        },
                                                                        "created_at": {
                                                                            "type": [
                                                                                "integer",
                                                                                "null"
                                                                            ],
                                                                            "description": "When the answer was written, as a count of seconds since 1970."
                                                                        }
                                                                    }
                                                                }
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the comment was written, as a count of seconds since 1970."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the comment last changed, as a count of seconds since 1970."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "changelog_comment",
                                            "id": "6b2f9d41-8c37-4e05-a1d6-3f9e7c2b5a84",
                                            "attributes": {
                                                "author_name": "Dwight Schrute",
                                                "is_mine": true,
                                                "is_private": false,
                                                "is_anonymous": false,
                                                "body": "The conference room should require a key card. Security is not a game.",
                                                "replies": [
                                                    {
                                                        "author_name": "Michael Scott",
                                                        "body": "Noted, Dwight. The key card stays in my office.",
                                                        "created_at": 1794830400
                                                    }
                                                ],
                                                "created_at": 1794823200,
                                                "updated_at": 1794823200
                                            }
                                        },
                                        {
                                            "type": "changelog_comment",
                                            "id": "e1a7c3d9-4b52-4f86-9c0e-7d3a5f1b8e26",
                                            "attributes": {
                                                "author_name": "Anonymous",
                                                "is_mine": false,
                                                "is_private": false,
                                                "is_anonymous": true,
                                                "body": "Can we book it for the Dundies?",
                                                "replies": [],
                                                "created_at": 1794826800,
                                                "updated_at": 1794826800
                                            }
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "changelog-entries-comments-index-query",
                "tags": [
                    "What’s new"
                ],
                "summary": "List the comments of a change",
                "description": "List the comments you can read under a change, oldest first.\n\nYou read the public comments, except those an administrator hid, and every comment of your own, private or hidden. The list is whole rather than paginated.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "entry",
                        "in": "path",
                        "required": true,
                        "description": "The identifier of the change, the 26 characters it reports as id. A change that does not exist or is not published yet answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Every comment object you can read, or an empty list. A change that does not exist answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "Every comment you can read under the change, whole rather than a page at a time.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One comment.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always changelog_comment. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The identifier of this comment."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the comment holds.",
                                                        "properties": {
                                                            "author_name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The name of the person who wrote it, or Anonymous, in your language, when they chose not to show it. An anonymous comment shows Anonymous to everybody, its author included."
                                                            },
                                                            "is_mine": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether you wrote it."
                                                            },
                                                            "is_private": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether only the administrators of the instance read it. Only its author sees a private comment in this list."
                                                            },
                                                            "is_anonymous": {
                                                                "type": [
                                                                    "boolean",
                                                                    "null"
                                                                ],
                                                                "description": "Whether it is shown without the name of its author. A private comment is never anonymous."
                                                            },
                                                            "body": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The comment, as plain text."
                                                            },
                                                            "replies": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "The public answers of the administrators, oldest first, or an empty list.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One answer.",
                                                                    "properties": {
                                                                        "author_name": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The name the administrator answered under."
                                                                        },
                                                                        "body": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The answer, as plain text."
                                                                        },
                                                                        "created_at": {
                                                                            "type": [
                                                                                "integer",
                                                                                "null"
                                                                            ],
                                                                            "description": "When the answer was written, as a count of seconds since 1970."
                                                                        }
                                                                    }
                                                                }
                                                            },
                                                            "created_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the comment was written, as a count of seconds since 1970."
                                                            },
                                                            "updated_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the comment last changed, as a count of seconds since 1970."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "changelog_comment",
                                            "id": "6b2f9d41-8c37-4e05-a1d6-3f9e7c2b5a84",
                                            "attributes": {
                                                "author_name": "Dwight Schrute",
                                                "is_mine": true,
                                                "is_private": false,
                                                "is_anonymous": false,
                                                "body": "The conference room should require a key card. Security is not a game.",
                                                "replies": [
                                                    {
                                                        "author_name": "Michael Scott",
                                                        "body": "Noted, Dwight. The key card stays in my office.",
                                                        "created_at": 1794830400
                                                    }
                                                ],
                                                "created_at": 1794823200,
                                                "updated_at": 1794823200
                                            }
                                        },
                                        {
                                            "type": "changelog_comment",
                                            "id": "e1a7c3d9-4b52-4f86-9c0e-7d3a5f1b8e26",
                                            "attributes": {
                                                "author_name": "Anonymous",
                                                "is_mine": false,
                                                "is_private": false,
                                                "is_anonymous": true,
                                                "body": "Can we book it for the Dundies?",
                                                "replies": [],
                                                "created_at": 1794826800,
                                                "updated_at": 1794826800
                                            }
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "post": {
                "operationId": "changelog-entries-comments-create",
                "tags": [
                    "What’s new"
                ],
                "summary": "Comment on a change",
                "description": "Write a comment under a change, for everybody or for the administrators only.\n\nMarkup is stripped from the comment. Every comment waits for an administrator to review it, and a public one is shown to everybody in the meantime. An administrator may hide a public comment, after which only its author reads it.\n\nA comment that is missing or longer than 2,000 characters answers 422 on body.\n\nRate limit: Ten requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "entry",
                        "in": "path",
                        "required": true,
                        "description": "The identifier of the change, the 26 characters it reports as id. A change that does not exist or is not published yet answers 404.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "body": {
                                        "type": "string",
                                        "description": "The comment, up to 2,000 characters."
                                    },
                                    "is_private": {
                                        "type": "boolean",
                                        "description": "Whether only the administrators of the instance read it. False when left out."
                                    },
                                    "is_anonymous": {
                                        "type": "boolean",
                                        "description": "Whether to show it without your name. False when left out, and ignored on a private comment."
                                    }
                                },
                                "required": [
                                    "body"
                                ]
                            },
                            "example": {
                                "body": "Can we book it for the Dundies?",
                                "is_anonymous": true
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The new comment object. A change that does not exist answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The comment.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always changelog_comment. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "author_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The name of the person who wrote it, or Anonymous, in your language, when they chose not to show it. An anonymous comment shows Anonymous to everybody, its author included."
                                                        },
                                                        "is_mine": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether you wrote it."
                                                        },
                                                        "is_private": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether only the administrators of the instance read it. Only its author sees a private comment in this list."
                                                        },
                                                        "is_anonymous": {
                                                            "type": [
                                                                "boolean",
                                                                "null"
                                                            ],
                                                            "description": "Whether it is shown without the name of its author. A private comment is never anonymous."
                                                        },
                                                        "body": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The comment, as plain text."
                                                        },
                                                        "replies": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The public answers of the administrators, which is an empty list for a new comment."
                                                        },
                                                        "created_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the comment was written, as a count of seconds since 1970."
                                                        },
                                                        "updated_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the comment last changed, as a count of seconds since 1970."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "changelog_comment",
                                        "id": "e1a7c3d9-4b52-4f86-9c0e-7d3a5f1b8e26",
                                        "attributes": {
                                            "author_name": "Anonymous",
                                            "is_mine": true,
                                            "is_private": false,
                                            "is_anonymous": true,
                                            "body": "Can we book it for the Dundies?",
                                            "replies": [],
                                            "created_at": 1794826800,
                                            "updated_at": 1794826800
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/admin/agent-feedback": {
            "get": {
                "operationId": "admin-agent-feedback-index",
                "tags": [
                    "Agent feedback"
                ],
                "summary": "List agent feedback reports",
                "description": "List the reports agents sent from every account, the newest first. The notes are left out of a list. Read one report to get them.\n\nOnly an administrator of this instance can use this endpoint, and only with an API key that carries the administration scope by name. Anybody else, including an administrator whose key does not carry it, gets 404 as though the endpoint did not exist.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "status",
                        "in": "query",
                        "required": false,
                        "description": "Which reports to list: new, accepted, fixed, dismissed or all. Any other value is taken as new.",
                        "schema": {
                            "type": "string",
                            "default": "new"
                        }
                    },
                    {
                        "name": "q",
                        "in": "query",
                        "required": false,
                        "description": "Keep only the reports whose title, tool, or user name or email holds this text.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "kind",
                        "in": "query",
                        "required": false,
                        "description": "Keep only one kind: bug, missing_tool, unclear_description or improvement.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "severity",
                        "in": "query",
                        "required": false,
                        "description": "Keep only one severity: blocks_task, needs_workaround or minor.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to answer with.",
                        "schema": {
                            "type": "integer",
                            "default": 1
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of report objects, how many there are in all, and in meta.counts how many each status holds.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The reports on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One report.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always agent_feedback_report. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "number": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "The number administrators read the report by, such as 48 for #48."
                                                            },
                                                            "status": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "new, accepted, fixed or dismissed."
                                                            },
                                                            "kind": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "bug, missing_tool, unclear_description or improvement."
                                                            },
                                                            "severity": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "blocks_task, needs_workaround or minor."
                                                            },
                                                            "title": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "One line naming the problem."
                                                            },
                                                            "tool": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The MCP tool the report is about, as the agent wrote it, or null."
                                                            },
                                                            "request": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the person asked, paraphrased by the agent, or null."
                                                            },
                                                            "steps": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "The tool calls the agent tried, in order. An empty list when it sent none.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One tool call.",
                                                                    "properties": {
                                                                        "tool": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The tool it called."
                                                                        },
                                                                        "arguments": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The arguments it sent, as the agent wrote them, or null."
                                                                        },
                                                                        "outcome": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "success or error."
                                                                        },
                                                                        "result": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "What came back, or null."
                                                                        }
                                                                    }
                                                                }
                                                            },
                                                            "observed": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What happened."
                                                            },
                                                            "expected": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What should have happened."
                                                            },
                                                            "proposed_fix": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The fix the agent suggests."
                                                            },
                                                            "proposed_code": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Code the agent suggests for the fix, or null."
                                                            },
                                                            "model": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The model the agent says it runs on, or null."
                                                            },
                                                            "connection_name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The connected assistant or the API key the report came through."
                                                            },
                                                            "account_id": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "The account the agent was working in."
                                                            },
                                                            "user": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "Who the agent was working for, or null once their user is deleted.",
                                                                "properties": {
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Their name."
                                                                    },
                                                                    "email": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Their email address."
                                                                    }
                                                                }
                                                            },
                                                            "submitted_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the report was sent, as a count of seconds since 1970."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "agent_feedback_report",
                                            "id": "3d9b7e21-6f4a-4c85-9a02-b81e5c47d613",
                                            "attributes": {
                                                "number": 48,
                                                "status": "new",
                                                "kind": "bug",
                                                "severity": "blocks_task",
                                                "title": "Yearly reminders on 29 February are refused",
                                                "tool": "create-contact-reminder",
                                                "request": "Add a yearly reminder for the birthday of a cousin born on 29 February.",
                                                "steps": [
                                                    {
                                                        "tool": "create-contact-reminder",
                                                        "arguments": "{\"contact\": \"<contact>\", \"day\": 29, \"month\": 2}",
                                                        "outcome": "error",
                                                        "result": "The date field must be a valid date."
                                                    }
                                                ],
                                                "observed": "Any reminder on 29 February fails validation, with or without a year.",
                                                "expected": "The reminder is created and falls on 28 February in other years.",
                                                "proposed_fix": "Validate the day against a leap year when no year is given.",
                                                "proposed_code": null,
                                                "model": "Claude Opus",
                                                "connection_name": "Claude Desktop",
                                                "account_id": 12,
                                                "user": {
                                                    "name": "Michael Scott",
                                                    "email": "michael.scott@dundermifflin.test"
                                                },
                                                "submitted_at": 1791547200
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/admin/agent-feedback/3d9b7e21-6f4a-4c85-9a02-b81e5c47d613"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 10,
                                        "total": 1,
                                        "counts": {
                                            "new": 1,
                                            "accepted": 0,
                                            "fixed": 0,
                                            "dismissed": 0,
                                            "all": 1
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "admin-agent-feedback-index-query",
                "tags": [
                    "Agent feedback"
                ],
                "summary": "List agent feedback reports",
                "description": "List the reports agents sent from every account, the newest first. The notes are left out of a list. Read one report to get them.\n\nOnly an administrator of this instance can use this endpoint, and only with an API key that carries the administration scope by name. Anybody else, including an administrator whose key does not carry it, gets 404 as though the endpoint did not exist.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "status": {
                                        "type": "string",
                                        "default": "new",
                                        "description": "Which reports to list: new, accepted, fixed, dismissed or all. Any other value is taken as new."
                                    },
                                    "q": {
                                        "type": "string",
                                        "description": "Keep only the reports whose title, tool, or user name or email holds this text."
                                    },
                                    "kind": {
                                        "type": "string",
                                        "description": "Keep only one kind: bug, missing_tool, unclear_description or improvement."
                                    },
                                    "severity": {
                                        "type": "string",
                                        "description": "Keep only one severity: blocks_task, needs_workaround or minor."
                                    },
                                    "page": {
                                        "type": "integer",
                                        "default": 1,
                                        "description": "Which page to answer with."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "A page of report objects, how many there are in all, and in meta.counts how many each status holds.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "array",
                                                "null"
                                            ],
                                            "description": "The reports on this page. An empty list rather than an error when there are none.",
                                            "items": {
                                                "type": [
                                                    "object",
                                                    "null"
                                                ],
                                                "description": "One report.",
                                                "properties": {
                                                    "type": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "Always agent_feedback_report. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                    },
                                                    "id": {
                                                        "type": [
                                                            "string",
                                                            "null"
                                                        ],
                                                        "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                    },
                                                    "attributes": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Everything the record holds.",
                                                        "properties": {
                                                            "number": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "The number administrators read the report by, such as 48 for #48."
                                                            },
                                                            "status": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "new, accepted, fixed or dismissed."
                                                            },
                                                            "kind": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "bug, missing_tool, unclear_description or improvement."
                                                            },
                                                            "severity": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "blocks_task, needs_workaround or minor."
                                                            },
                                                            "title": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "One line naming the problem."
                                                            },
                                                            "tool": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The MCP tool the report is about, as the agent wrote it, or null."
                                                            },
                                                            "request": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What the person asked, paraphrased by the agent, or null."
                                                            },
                                                            "steps": {
                                                                "type": [
                                                                    "array",
                                                                    "null"
                                                                ],
                                                                "description": "The tool calls the agent tried, in order. An empty list when it sent none.",
                                                                "items": {
                                                                    "type": [
                                                                        "object",
                                                                        "null"
                                                                    ],
                                                                    "description": "One tool call.",
                                                                    "properties": {
                                                                        "tool": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The tool it called."
                                                                        },
                                                                        "arguments": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "The arguments it sent, as the agent wrote them, or null."
                                                                        },
                                                                        "outcome": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "success or error."
                                                                        },
                                                                        "result": {
                                                                            "type": [
                                                                                "string",
                                                                                "null"
                                                                            ],
                                                                            "description": "What came back, or null."
                                                                        }
                                                                    }
                                                                }
                                                            },
                                                            "observed": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What happened."
                                                            },
                                                            "expected": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "What should have happened."
                                                            },
                                                            "proposed_fix": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The fix the agent suggests."
                                                            },
                                                            "proposed_code": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "Code the agent suggests for the fix, or null."
                                                            },
                                                            "model": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The model the agent says it runs on, or null."
                                                            },
                                                            "connection_name": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The connected assistant or the API key the report came through."
                                                            },
                                                            "account_id": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "The account the agent was working in."
                                                            },
                                                            "user": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "Who the agent was working for, or null once their user is deleted.",
                                                                "properties": {
                                                                    "name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Their name."
                                                                    },
                                                                    "email": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "Their email address."
                                                                    }
                                                                }
                                                            },
                                                            "submitted_at": {
                                                                "type": [
                                                                    "integer",
                                                                    "null"
                                                                ],
                                                                "description": "When the report was sent, as a count of seconds since 1970."
                                                            }
                                                        }
                                                    },
                                                    "links": {
                                                        "type": [
                                                            "object",
                                                            "null"
                                                        ],
                                                        "description": "Where to find this record.",
                                                        "properties": {
                                                            "self": {
                                                                "type": [
                                                                    "string",
                                                                    "null"
                                                                ],
                                                                "description": "The absolute address this record is read from."
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "meta": {
                                            "$ref": "#/components/schemas/PaginationMeta"
                                        }
                                    }
                                },
                                "example": {
                                    "data": [
                                        {
                                            "type": "agent_feedback_report",
                                            "id": "3d9b7e21-6f4a-4c85-9a02-b81e5c47d613",
                                            "attributes": {
                                                "number": 48,
                                                "status": "new",
                                                "kind": "bug",
                                                "severity": "blocks_task",
                                                "title": "Yearly reminders on 29 February are refused",
                                                "tool": "create-contact-reminder",
                                                "request": "Add a yearly reminder for the birthday of a cousin born on 29 February.",
                                                "steps": [
                                                    {
                                                        "tool": "create-contact-reminder",
                                                        "arguments": "{\"contact\": \"<contact>\", \"day\": 29, \"month\": 2}",
                                                        "outcome": "error",
                                                        "result": "The date field must be a valid date."
                                                    }
                                                ],
                                                "observed": "Any reminder on 29 February fails validation, with or without a year.",
                                                "expected": "The reminder is created and falls on 28 February in other years.",
                                                "proposed_fix": "Validate the day against a leap year when no year is given.",
                                                "proposed_code": null,
                                                "model": "Claude Opus",
                                                "connection_name": "Claude Desktop",
                                                "account_id": 12,
                                                "user": {
                                                    "name": "Michael Scott",
                                                    "email": "michael.scott@dundermifflin.test"
                                                },
                                                "submitted_at": 1791547200
                                            },
                                            "links": {
                                                "self": "https://my.monicahq.com/api/v1/admin/agent-feedback/3d9b7e21-6f4a-4c85-9a02-b81e5c47d613"
                                            }
                                        }
                                    ],
                                    "meta": {
                                        "page": 1,
                                        "per_page": 10,
                                        "total": 1,
                                        "counts": {
                                            "new": 1,
                                            "accepted": 0,
                                            "fixed": 0,
                                            "dismissed": 0,
                                            "all": 1
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/admin/agent-feedback/{agentFeedbackReport}": {
            "get": {
                "operationId": "admin-agent-feedback-show",
                "tags": [
                    "Agent feedback"
                ],
                "summary": "Get an agent feedback report",
                "description": "Return one report of any account, with the notes administrators left on it.\n\nOnly an administrator of this instance can use this endpoint, and only with an API key that carries the administration scope by name. Anybody else, including an administrator whose key does not carry it, gets 404 as though the endpoint did not exist.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "agentFeedbackReport",
                        "in": "path",
                        "required": true,
                        "description": "The id of the report, of any account on the instance.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The report object. An id that matches no report answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The report.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always agent_feedback_report. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "number": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The number administrators read the report by, such as 48 for #48."
                                                        },
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "new, accepted, fixed or dismissed."
                                                        },
                                                        "kind": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "bug, missing_tool, unclear_description or improvement."
                                                        },
                                                        "severity": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "blocks_task, needs_workaround or minor."
                                                        },
                                                        "title": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One line naming the problem."
                                                        },
                                                        "tool": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The MCP tool the report is about, as the agent wrote it, or null."
                                                        },
                                                        "request": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the person asked, paraphrased by the agent, or null."
                                                        },
                                                        "steps": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The tool calls the agent tried, in order. An empty list when it sent none.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One tool call.",
                                                                "properties": {
                                                                    "tool": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The tool it called."
                                                                    },
                                                                    "arguments": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The arguments it sent, as the agent wrote them, or null."
                                                                    },
                                                                    "outcome": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "success or error."
                                                                    },
                                                                    "result": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What came back, or null."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "observed": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What happened."
                                                        },
                                                        "expected": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What should have happened."
                                                        },
                                                        "proposed_fix": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The fix the agent suggests."
                                                        },
                                                        "proposed_code": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Code the agent suggests for the fix, or null."
                                                        },
                                                        "model": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The model the agent says it runs on, or null."
                                                        },
                                                        "connection_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The connected assistant or the API key the report came through."
                                                        },
                                                        "account_id": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The account the agent was working in."
                                                        },
                                                        "user": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "Who the agent was working for, or null once their user is deleted.",
                                                            "properties": {
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "Their name."
                                                                },
                                                                "email": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "Their email address."
                                                                }
                                                            }
                                                        },
                                                        "submitted_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the report was sent, as a count of seconds since 1970."
                                                        },
                                                        "notes": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The notes administrators left on it, the oldest first.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One note.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the note."
                                                                    },
                                                                    "author_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name of the administrator who wrote it."
                                                                    },
                                                                    "body": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What was written, as plain text."
                                                                    },
                                                                    "created_at": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "When it was written, as a count of seconds since 1970."
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "agent_feedback_report",
                                        "id": "3d9b7e21-6f4a-4c85-9a02-b81e5c47d613",
                                        "attributes": {
                                            "number": 48,
                                            "status": "new",
                                            "kind": "bug",
                                            "severity": "blocks_task",
                                            "title": "Yearly reminders on 29 February are refused",
                                            "tool": "create-contact-reminder",
                                            "request": "Add a yearly reminder for the birthday of a cousin born on 29 February.",
                                            "steps": [
                                                {
                                                    "tool": "create-contact-reminder",
                                                    "arguments": "{\"contact\": \"<contact>\", \"day\": 29, \"month\": 2}",
                                                    "outcome": "error",
                                                    "result": "The date field must be a valid date."
                                                }
                                            ],
                                            "observed": "Any reminder on 29 February fails validation, with or without a year.",
                                            "expected": "The reminder is created and falls on 28 February in other years.",
                                            "proposed_fix": "Validate the day against a leap year when no year is given.",
                                            "proposed_code": null,
                                            "model": "Claude Opus",
                                            "connection_name": "Claude Desktop",
                                            "account_id": 12,
                                            "user": {
                                                "name": "Michael Scott",
                                                "email": "michael.scott@dundermifflin.test"
                                            },
                                            "submitted_at": 1791547200,
                                            "notes": [
                                                {
                                                    "id": "9f2c4a71-0d8e-4b36-a5c1-7e3b90d26f48",
                                                    "author_name": "Jim Halpert",
                                                    "body": "Confirmed on a test account. Planned for the next release.",
                                                    "created_at": 1791550800
                                                }
                                            ]
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/admin/agent-feedback/3d9b7e21-6f4a-4c85-9a02-b81e5c47d613"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            },
            "query": {
                "operationId": "admin-agent-feedback-show-query",
                "tags": [
                    "Agent feedback"
                ],
                "summary": "Get an agent feedback report",
                "description": "Return one report of any account, with the notes administrators left on it.\n\nOnly an administrator of this instance can use this endpoint, and only with an API key that carries the administration scope by name. Anybody else, including an administrator whose key does not carry it, gets 404 as though the endpoint did not exist.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "agentFeedbackReport",
                        "in": "path",
                        "required": true,
                        "description": "The id of the report, of any account on the instance.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The report object. An id that matches no report answers 404.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The report.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always agent_feedback_report. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "number": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The number administrators read the report by, such as 48 for #48."
                                                        },
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "new, accepted, fixed or dismissed."
                                                        },
                                                        "kind": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "bug, missing_tool, unclear_description or improvement."
                                                        },
                                                        "severity": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "blocks_task, needs_workaround or minor."
                                                        },
                                                        "title": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One line naming the problem."
                                                        },
                                                        "tool": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The MCP tool the report is about, as the agent wrote it, or null."
                                                        },
                                                        "request": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the person asked, paraphrased by the agent, or null."
                                                        },
                                                        "steps": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The tool calls the agent tried, in order. An empty list when it sent none.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One tool call.",
                                                                "properties": {
                                                                    "tool": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The tool it called."
                                                                    },
                                                                    "arguments": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The arguments it sent, as the agent wrote them, or null."
                                                                    },
                                                                    "outcome": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "success or error."
                                                                    },
                                                                    "result": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What came back, or null."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "observed": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What happened."
                                                        },
                                                        "expected": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What should have happened."
                                                        },
                                                        "proposed_fix": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The fix the agent suggests."
                                                        },
                                                        "proposed_code": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Code the agent suggests for the fix, or null."
                                                        },
                                                        "model": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The model the agent says it runs on, or null."
                                                        },
                                                        "connection_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The connected assistant or the API key the report came through."
                                                        },
                                                        "account_id": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The account the agent was working in."
                                                        },
                                                        "user": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "Who the agent was working for, or null once their user is deleted.",
                                                            "properties": {
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "Their name."
                                                                },
                                                                "email": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "Their email address."
                                                                }
                                                            }
                                                        },
                                                        "submitted_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the report was sent, as a count of seconds since 1970."
                                                        },
                                                        "notes": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The notes administrators left on it, the oldest first.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One note.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the note."
                                                                    },
                                                                    "author_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name of the administrator who wrote it."
                                                                    },
                                                                    "body": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What was written, as plain text."
                                                                    },
                                                                    "created_at": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "When it was written, as a count of seconds since 1970."
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "agent_feedback_report",
                                        "id": "3d9b7e21-6f4a-4c85-9a02-b81e5c47d613",
                                        "attributes": {
                                            "number": 48,
                                            "status": "new",
                                            "kind": "bug",
                                            "severity": "blocks_task",
                                            "title": "Yearly reminders on 29 February are refused",
                                            "tool": "create-contact-reminder",
                                            "request": "Add a yearly reminder for the birthday of a cousin born on 29 February.",
                                            "steps": [
                                                {
                                                    "tool": "create-contact-reminder",
                                                    "arguments": "{\"contact\": \"<contact>\", \"day\": 29, \"month\": 2}",
                                                    "outcome": "error",
                                                    "result": "The date field must be a valid date."
                                                }
                                            ],
                                            "observed": "Any reminder on 29 February fails validation, with or without a year.",
                                            "expected": "The reminder is created and falls on 28 February in other years.",
                                            "proposed_fix": "Validate the day against a leap year when no year is given.",
                                            "proposed_code": null,
                                            "model": "Claude Opus",
                                            "connection_name": "Claude Desktop",
                                            "account_id": 12,
                                            "user": {
                                                "name": "Michael Scott",
                                                "email": "michael.scott@dundermifflin.test"
                                            },
                                            "submitted_at": 1791547200,
                                            "notes": [
                                                {
                                                    "id": "9f2c4a71-0d8e-4b36-a5c1-7e3b90d26f48",
                                                    "author_name": "Jim Halpert",
                                                    "body": "Confirmed on a test account. Planned for the next release.",
                                                    "created_at": 1791550800
                                                }
                                            ]
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/admin/agent-feedback/3d9b7e21-6f4a-4c85-9a02-b81e5c47d613"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/agent-feedback": {
            "post": {
                "operationId": "agent-feedback-create",
                "tags": [
                    "Agent feedback"
                ],
                "summary": "Send agent feedback",
                "description": "Tell the administrators of this instance about a problem with a tool. This is what the submit-feedback MCP tool calls. The person the agent works for never sees the report in Monica, only the call in their MCP history.\n\nSend it at most once per task, and only when a tool got in the way. Paraphrase what the person asked, and use placeholders such as <contact> or <date> instead of names, dates and other details from the vault. Never include secrets.\n\nRate limit: Ten requests per minute, per user.",
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "kind": {
                                        "type": "string",
                                        "description": "bug when a tool failed or returned something wrong, missing_tool when no tool could do it, unclear_description when a description misled you, improvement for a suggestion."
                                    },
                                    "severity": {
                                        "type": "string",
                                        "description": "blocks_task when the task could not be finished, needs_workaround when it was finished another way, minor when it was finished with friction."
                                    },
                                    "title": {
                                        "type": "string",
                                        "description": "One line naming the problem, up to 200 characters."
                                    },
                                    "tool": {
                                        "type": "string",
                                        "description": "The tool the report is about, or the name of the tool that is missing, up to 100 characters."
                                    },
                                    "request": {
                                        "type": "string",
                                        "description": "What the person asked, paraphrased, up to 4,000 characters."
                                    },
                                    "steps": {
                                        "type": "array",
                                        "description": "The tool calls tried, in order, at most 20. Each holds tool (required), arguments as a string, outcome (success or error, required) and result."
                                    },
                                    "observed": {
                                        "type": "string",
                                        "description": "What happened, up to 4,000 characters. A placeholder such as test, todo or n/a answers 422."
                                    },
                                    "expected": {
                                        "type": "string",
                                        "description": "What should have happened, up to 4,000 characters."
                                    },
                                    "proposed_fix": {
                                        "type": "string",
                                        "description": "The fix you suggest, up to 4,000 characters."
                                    },
                                    "proposed_code": {
                                        "type": "string",
                                        "description": "Code for the fix, up to 8,000 characters."
                                    },
                                    "model": {
                                        "type": "string",
                                        "description": "The model the agent runs on, up to 100 characters."
                                    }
                                },
                                "required": [
                                    "kind",
                                    "severity",
                                    "title",
                                    "observed",
                                    "expected",
                                    "proposed_fix"
                                ]
                            },
                            "example": {
                                "kind": "bug",
                                "severity": "blocks_task",
                                "title": "Yearly reminders on 29 February are refused",
                                "tool": "create-contact-reminder",
                                "steps": [
                                    {
                                        "tool": "create-contact-reminder",
                                        "arguments": "{\"contact\": \"<contact>\", \"day\": 29, \"month\": 2}",
                                        "outcome": "error",
                                        "result": "The date field must be a valid date."
                                    }
                                ],
                                "observed": "Any reminder on 29 February fails validation, with or without a year.",
                                "expected": "The reminder is created and falls on 28 February in other years.",
                                "proposed_fix": "Validate the day against a leap year when no year is given."
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The id of the report and its status.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "id": {
                                            "type": [
                                                "string",
                                                "null"
                                            ],
                                            "format": "uuid",
                                            "description": "The id of the report."
                                        },
                                        "status": {
                                            "type": [
                                                "string",
                                                "null"
                                            ],
                                            "description": "Always new."
                                        }
                                    }
                                },
                                "example": {
                                    "id": "3d9b7e21-6f4a-4c85-9a02-b81e5c47d613",
                                    "status": "new"
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/admin/agent-feedback/{agentFeedbackReport}/notes": {
            "post": {
                "operationId": "admin-agent-feedback-notes-create",
                "tags": [
                    "Agent feedback"
                ],
                "summary": "Leave a note on an agent feedback report",
                "description": "Write a note that only the administrators read. The status does not change.\n\nOnly an administrator of this instance can use this endpoint, and only with an API key that carries the administration scope by name. Anybody else, including an administrator whose key does not carry it, gets 404 as though the endpoint did not exist.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "agentFeedbackReport",
                        "in": "path",
                        "required": true,
                        "description": "The id of the report, of any account on the instance.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "body": {
                                        "type": "string",
                                        "description": "What to write, up to 4,000 characters. A body left empty answers 422."
                                    }
                                },
                                "required": [
                                    "body"
                                ]
                            },
                            "example": {
                                "body": "Confirmed on a test account. Planned for the next release."
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "The report object with its notes.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The report.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always agent_feedback_report. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "number": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The number administrators read the report by, such as 48 for #48."
                                                        },
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "new, accepted, fixed or dismissed."
                                                        },
                                                        "kind": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "bug, missing_tool, unclear_description or improvement."
                                                        },
                                                        "severity": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "blocks_task, needs_workaround or minor."
                                                        },
                                                        "title": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One line naming the problem."
                                                        },
                                                        "tool": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The MCP tool the report is about, as the agent wrote it, or null."
                                                        },
                                                        "request": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the person asked, paraphrased by the agent, or null."
                                                        },
                                                        "steps": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The tool calls the agent tried, in order. An empty list when it sent none.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One tool call.",
                                                                "properties": {
                                                                    "tool": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The tool it called."
                                                                    },
                                                                    "arguments": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The arguments it sent, as the agent wrote them, or null."
                                                                    },
                                                                    "outcome": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "success or error."
                                                                    },
                                                                    "result": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What came back, or null."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "observed": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What happened."
                                                        },
                                                        "expected": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What should have happened."
                                                        },
                                                        "proposed_fix": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The fix the agent suggests."
                                                        },
                                                        "proposed_code": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Code the agent suggests for the fix, or null."
                                                        },
                                                        "model": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The model the agent says it runs on, or null."
                                                        },
                                                        "connection_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The connected assistant or the API key the report came through."
                                                        },
                                                        "account_id": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The account the agent was working in."
                                                        },
                                                        "user": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "Who the agent was working for, or null once their user is deleted.",
                                                            "properties": {
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "Their name."
                                                                },
                                                                "email": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "Their email address."
                                                                }
                                                            }
                                                        },
                                                        "submitted_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the report was sent, as a count of seconds since 1970."
                                                        },
                                                        "notes": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The notes administrators left on it, the oldest first.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One note.",
                                                                "properties": {
                                                                    "id": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "format": "uuid",
                                                                        "description": "The id of the note."
                                                                    },
                                                                    "author_name": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The name of the administrator who wrote it."
                                                                    },
                                                                    "body": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What was written, as plain text."
                                                                    },
                                                                    "created_at": {
                                                                        "type": [
                                                                            "integer",
                                                                            "null"
                                                                        ],
                                                                        "description": "When it was written, as a count of seconds since 1970."
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "agent_feedback_report",
                                        "id": "3d9b7e21-6f4a-4c85-9a02-b81e5c47d613",
                                        "attributes": {
                                            "number": 48,
                                            "status": "new",
                                            "kind": "bug",
                                            "severity": "blocks_task",
                                            "title": "Yearly reminders on 29 February are refused",
                                            "tool": "create-contact-reminder",
                                            "request": "Add a yearly reminder for the birthday of a cousin born on 29 February.",
                                            "steps": [
                                                {
                                                    "tool": "create-contact-reminder",
                                                    "arguments": "{\"contact\": \"<contact>\", \"day\": 29, \"month\": 2}",
                                                    "outcome": "error",
                                                    "result": "The date field must be a valid date."
                                                }
                                            ],
                                            "observed": "Any reminder on 29 February fails validation, with or without a year.",
                                            "expected": "The reminder is created and falls on 28 February in other years.",
                                            "proposed_fix": "Validate the day against a leap year when no year is given.",
                                            "proposed_code": null,
                                            "model": "Claude Opus",
                                            "connection_name": "Claude Desktop",
                                            "account_id": 12,
                                            "user": {
                                                "name": "Michael Scott",
                                                "email": "michael.scott@dundermifflin.test"
                                            },
                                            "submitted_at": 1791547200,
                                            "notes": [
                                                {
                                                    "id": "9f2c4a71-0d8e-4b36-a5c1-7e3b90d26f48",
                                                    "author_name": "Jim Halpert",
                                                    "body": "Confirmed on a test account. Planned for the next release.",
                                                    "created_at": 1791550800
                                                }
                                            ]
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/admin/agent-feedback/3d9b7e21-6f4a-4c85-9a02-b81e5c47d613"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/admin/agent-feedback/{agentFeedbackReport}/status": {
            "put": {
                "operationId": "admin-agent-feedback-status-update",
                "tags": [
                    "Agent feedback"
                ],
                "summary": "Change the status of an agent feedback report",
                "description": "Move a report along. A new report can be accepted or dismissed, an accepted one fixed or dismissed, and a fixed or dismissed one reopened to new. The move is written to the administrator log.\n\nOnly an administrator of this instance can use this endpoint, and only with an API key that carries the administration scope by name. Anybody else, including an administrator whose key does not carry it, gets 404 as though the endpoint did not exist.\n\nRate limit: Sixty requests per minute, per user, shared by every key and device.",
                "parameters": [
                    {
                        "name": "agentFeedbackReport",
                        "in": "path",
                        "required": true,
                        "description": "The id of the report, of any account on the instance.",
                        "schema": {
                            "type": "string",
                            "format": "uuid"
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "status": {
                                        "type": "string",
                                        "description": "The status to move to: new, accepted, fixed or dismissed. A move the current status does not allow answers 422 on status, naming both statuses."
                                    }
                                },
                                "required": [
                                    "status"
                                ]
                            },
                            "example": {
                                "status": "accepted"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The report object as it stands now, without its notes. Read the report to get them.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": [
                                                "object",
                                                "null"
                                            ],
                                            "description": "The report.",
                                            "properties": {
                                                "type": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "Always agent_feedback_report. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from."
                                                },
                                                "id": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ],
                                                    "description": "The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes."
                                                },
                                                "attributes": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Everything the record holds.",
                                                    "properties": {
                                                        "number": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The number administrators read the report by, such as 48 for #48."
                                                        },
                                                        "status": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "new, accepted, fixed or dismissed."
                                                        },
                                                        "kind": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "bug, missing_tool, unclear_description or improvement."
                                                        },
                                                        "severity": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "blocks_task, needs_workaround or minor."
                                                        },
                                                        "title": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "One line naming the problem."
                                                        },
                                                        "tool": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The MCP tool the report is about, as the agent wrote it, or null."
                                                        },
                                                        "request": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What the person asked, paraphrased by the agent, or null."
                                                        },
                                                        "steps": {
                                                            "type": [
                                                                "array",
                                                                "null"
                                                            ],
                                                            "description": "The tool calls the agent tried, in order. An empty list when it sent none.",
                                                            "items": {
                                                                "type": [
                                                                    "object",
                                                                    "null"
                                                                ],
                                                                "description": "One tool call.",
                                                                "properties": {
                                                                    "tool": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The tool it called."
                                                                    },
                                                                    "arguments": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "The arguments it sent, as the agent wrote them, or null."
                                                                    },
                                                                    "outcome": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "success or error."
                                                                    },
                                                                    "result": {
                                                                        "type": [
                                                                            "string",
                                                                            "null"
                                                                        ],
                                                                        "description": "What came back, or null."
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "observed": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What happened."
                                                        },
                                                        "expected": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "What should have happened."
                                                        },
                                                        "proposed_fix": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The fix the agent suggests."
                                                        },
                                                        "proposed_code": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "Code the agent suggests for the fix, or null."
                                                        },
                                                        "model": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The model the agent says it runs on, or null."
                                                        },
                                                        "connection_name": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The connected assistant or the API key the report came through."
                                                        },
                                                        "account_id": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "The account the agent was working in."
                                                        },
                                                        "user": {
                                                            "type": [
                                                                "object",
                                                                "null"
                                                            ],
                                                            "description": "Who the agent was working for, or null once their user is deleted.",
                                                            "properties": {
                                                                "name": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "Their name."
                                                                },
                                                                "email": {
                                                                    "type": [
                                                                        "string",
                                                                        "null"
                                                                    ],
                                                                    "description": "Their email address."
                                                                }
                                                            }
                                                        },
                                                        "submitted_at": {
                                                            "type": [
                                                                "integer",
                                                                "null"
                                                            ],
                                                            "description": "When the report was sent, as a count of seconds since 1970."
                                                        }
                                                    }
                                                },
                                                "links": {
                                                    "type": [
                                                        "object",
                                                        "null"
                                                    ],
                                                    "description": "Where to find this record.",
                                                    "properties": {
                                                        "self": {
                                                            "type": [
                                                                "string",
                                                                "null"
                                                            ],
                                                            "description": "The absolute address this record is read from."
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "example": {
                                    "data": {
                                        "type": "agent_feedback_report",
                                        "id": "3d9b7e21-6f4a-4c85-9a02-b81e5c47d613",
                                        "attributes": {
                                            "number": 48,
                                            "status": "accepted",
                                            "kind": "bug",
                                            "severity": "blocks_task",
                                            "title": "Yearly reminders on 29 February are refused",
                                            "tool": "create-contact-reminder",
                                            "request": "Add a yearly reminder for the birthday of a cousin born on 29 February.",
                                            "steps": [
                                                {
                                                    "tool": "create-contact-reminder",
                                                    "arguments": "{\"contact\": \"<contact>\", \"day\": 29, \"month\": 2}",
                                                    "outcome": "error",
                                                    "result": "The date field must be a valid date."
                                                }
                                            ],
                                            "observed": "Any reminder on 29 February fails validation, with or without a year.",
                                            "expected": "The reminder is created and falls on 28 February in other years.",
                                            "proposed_fix": "Validate the day against a leap year when no year is given.",
                                            "proposed_code": null,
                                            "model": "Claude Opus",
                                            "connection_name": "Claude Desktop",
                                            "account_id": 12,
                                            "user": {
                                                "name": "Michael Scott",
                                                "email": "michael.scott@dundermifflin.test"
                                            },
                                            "submitted_at": 1791547200
                                        },
                                        "links": {
                                            "self": "https://my.monicahq.com/api/v1/admin/agent-feedback/3d9b7e21-6f4a-4c85-9a02-b81e5c47d613"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "No token was sent, or the one sent has been revoked.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing answers to that. A record held by another account answers the same way, so that nothing is disclosed about it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The request was refused, with every field at fault named at once.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationError"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "The rate limit was reached. Retry-After says how long to wait.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "components": {
        "schemas": {
            "Error": {
                "type": "object",
                "properties": {
                    "message": {
                        "type": "string"
                    }
                },
                "required": [
                    "message"
                ]
            },
            "ValidationError": {
                "type": "object",
                "properties": {
                    "message": {
                        "type": "string"
                    },
                    "errors": {
                        "type": "object",
                        "additionalProperties": {
                            "type": "array",
                            "items": {
                                "type": "string"
                            }
                        }
                    }
                },
                "required": [
                    "message",
                    "errors"
                ]
            },
            "PaginationMeta": {
                "type": "object",
                "properties": {
                    "page": {
                        "type": "integer",
                        "description": "How many there are, and where in them this page sits."
                    },
                    "per_page": {
                        "type": "integer",
                        "description": "How many there are, and where in them this page sits."
                    },
                    "total": {
                        "type": "integer",
                        "description": "How many there are, and where in them this page sits."
                    }
                },
                "required": [
                    "page",
                    "per_page",
                    "total"
                ]
            }
        },
        "securitySchemes": {
            "bearerAuth": {
                "type": "http",
                "scheme": "bearer",
                "description": "A personal access token, sent as `Authorization: Bearer <token>`. Create one in Settings."
            }
        }
    }
}